diff options
| author | Victor Toso <victortoso@redhat.com> | 2015-11-03 12:16:01 +0100 |
|---|---|---|
| committer | Victor Toso <victortoso@redhat.com> | 2015-11-03 12:16:01 +0100 |
| commit | 461b4d993cb57080d8629133fcd9c1cdc4c28cd4 (patch) | |
| tree | 87931762015d848c84fe1ec23c27bd45fdb9f1b0 | |
| parent | 5c59b13f69b8ad4c7043993b23045fca5f5a3a95 (diff) | |
spice-gtk-api: included last from git master
Attempts to generate content from docbook failed. Moving docbook to
another acceptable format always introduced other problems. Very time
consuming with no benefit as this would have to be always re-done.
We are using the provided html inside of an iframe. Looks good enough
for now.
The spice-gtk.rst file only set this iframe and pelican include
everyting inside the template.
In order to not break links, the html from spice-gtk api is included and
copied to output folder.
44 files changed, 15523 insertions, 0 deletions
@@ -64,6 +64,7 @@ help: html: $(PELICAN) $(INPUTDIR) -o $(OUTPUTDIR) -s $(CONFFILE) $(PELICANOPTS) ln -sf $(OUTPUTDIR)/home.html $(OUTPUTDIR)/index.html + cp -r $(BASEDIR)/content-extra/* $(OUTPUTDIR) clean: [ ! -d $(OUTPUTDIR) ] || rm -rf $(OUTPUTDIR) @@ -100,6 +101,7 @@ stopserver: publish: $(PELICAN) $(INPUTDIR) -o $(OUTPUTDIR) -s $(PUBLISHCONF) $(PELICANOPTS) ln -sf $(OUTPUTDIR)/home.html $(OUTPUTDIR)/index.html + cp -r $(BASEDIR)/content-extra/* $(OUTPUTDIR) ssh_upload: publish scp -P $(SSH_PORT) -r $(OUTPUTDIR)/* $(SSH_USER)@$(SSH_HOST):$(SSH_TARGET_DIR) diff --git a/content-extra/api/spice-gtk/SpiceAudio.html b/content-extra/api/spice-gtk/SpiceAudio.html new file mode 100644 index 0000000..8c1724b --- /dev/null +++ b/content-extra/api/spice-gtk/SpiceAudio.html @@ -0,0 +1,277 @@ +<!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 Audio: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="application-support.html" title="Application Support, from spice-client-glib"> +<link rel="prev" href="application-support.html" title="Application Support, from spice-client-glib"> +<link rel="next" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"> +<meta name="generator" content="GTK-Doc V1.24 (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="#SpiceAudio.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#SpiceAudio.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#SpiceAudio.properties" class="shortcut">Properties</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="application-support.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="application-support.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="SpiceSmartcardManager.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="SpiceAudio"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="SpiceAudio.top_of_page"></a>Spice Audio</span></h2> +<p>Spice Audio — a helper to play and to record audio channels</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="SpiceAudio.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="SpiceAudio.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<a class="link" href="SpiceAudio.html" title="Spice Audio"><span class="returnvalue">SpiceAudio</span></a> * +</td> +<td class="function_name"> +<a class="link" href="SpiceAudio.html#spice-audio-get" title="spice_audio_get ()">spice_audio_get</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="SpiceAudio.html" title="Spice Audio"><span class="returnvalue">SpiceAudio</span></a> * +</td> +<td class="function_name"> +<a class="link" href="SpiceAudio.html#spice-audio-new" title="spice_audio_new ()">spice_audio_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceAudio.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceAudio.html#SpiceAudio--main-context" title="The “main-context” property">main-context</a></td> +<td class="property_flags">Read / Write / Construct Only</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="SpiceAudio.html#SpiceAudio--session" title="The “session” property">session</a></td> +<td class="property_flags">Read / Write / Construct Only</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceAudio.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceAudio.html#SpiceAudio-struct" title="struct SpiceAudio">SpiceAudio</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceAudio.html#SpiceAudioClass" title="struct SpiceAudioClass">SpiceAudioClass</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceAudio.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">╰──</span> SpiceAudio +</pre> +</div> +<div class="refsect1"> +<a name="SpiceAudio.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-client.h> +</pre> +</div> +<div class="refsect1"> +<a name="SpiceAudio.description"></a><h2>Description</h2> +<p>A class that handles the playback and record channels for your +application, and connect them to the default sound system.</p> +</div> +<div class="refsect1"> +<a name="SpiceAudio.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="spice-audio-get"></a><h3>spice_audio_get ()</h3> +<pre class="programlisting"><a class="link" href="SpiceAudio.html" title="Spice Audio"><span class="returnvalue">SpiceAudio</span></a> * +spice_audio_get (<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/glib/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *context</code></em>);</pre> +<p>Gets the <a class="link" href="SpiceAudio.html" title="Spice Audio"><span class="type">SpiceAudio</span></a> associated with the passed in <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a>. +A new <a class="link" href="SpiceAudio.html" title="Spice Audio"><span class="type">SpiceAudio</span></a> 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="id-1.2.5.2.10.2.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>the <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> to connect to</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>context</p></td> +<td class="parameter_description"><p> a <a href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> to attach to (or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for default). </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="id-1.2.5.2.10.2.7"></a><h4>Returns</h4> +<p> a weak reference to a <a class="link" href="SpiceAudio.html" title="Spice Audio"><span class="type">SpiceAudio</span></a> +instance or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if failed. </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-audio-new"></a><h3>spice_audio_new ()</h3> +<pre class="programlisting"><a class="link" href="SpiceAudio.html" title="Spice Audio"><span class="returnvalue">SpiceAudio</span></a> * +spice_audio_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><a href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *context</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre> +<div class="warning"> +<p><code class="literal">spice_audio_new</code> has been deprecated since version 0.8 and should not be used in newly-written code.</p> +<p>Use <a class="link" href="SpiceAudio.html#spice-audio-get" title="spice_audio_get ()"><code class="function">spice_audio_get()</code></a> instead</p> +</div> +<p>Once instantiated, <a class="link" href="SpiceAudio.html" title="Spice Audio"><span class="type">SpiceAudio</span></a> will handle the playback and record +channels to stream to your local audio system.</p> +<div class="refsect3"> +<a name="id-1.2.5.2.10.3.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>the <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> to connect to</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>context</p></td> +<td class="parameter_description"><p> a <a href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> to attach to (or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for +default). </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> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p> a name for the audio channels (or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for +application name). </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="id-1.2.5.2.10.3.7"></a><h4>Returns</h4> +<p> a new <a class="link" href="SpiceAudio.html" title="Spice Audio"><span class="type">SpiceAudio</span></a> instance or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no backend or failed.</p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="SpiceAudio.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SpiceAudio-struct"></a><h3>struct SpiceAudio</h3> +<pre class="programlisting">struct SpiceAudio;</pre> +<p>The <a class="link" href="SpiceAudio.html" title="Spice Audio"><span class="type">SpiceAudio</span></a> struct is opaque and should not be accessed directly.</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceAudioClass"></a><h3>struct SpiceAudioClass</h3> +<pre class="programlisting">struct SpiceAudioClass { + GObjectClass parent_class; +}; +</pre> +<p>Class structure for <a class="link" href="SpiceAudio.html" title="Spice Audio"><span class="type">SpiceAudio</span></a>.</p> +<div class="refsect3"> +<a name="id-1.2.5.2.11.3.5"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody><tr> +<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="SpiceAudioClass.parent-class"></a>parent_class</code></em>;</p></td> +<td class="struct_member_description"><p>Parent class.</p></td> +<td class="struct_member_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="SpiceAudio.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="SpiceAudio--main-context"></a><h3>The <code class="literal">“main-context”</code> property</h3> +<pre class="programlisting"> “main-context” <a href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *</pre> +<p>GMainContext to use for the event source.</p> +<p>Flags: Read / Write / Construct Only</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceAudio--session"></a><h3>The <code class="literal">“session”</code> property</h3> +<pre class="programlisting"> “session” <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> *</pre> +<p><a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> this <a class="link" href="SpiceAudio.html" title="Spice Audio"><span class="type">SpiceAudio</span></a> is associated with</p> +<p>Flags: Read / Write / Construct Only</p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceAudio.see-also"></a><h2>See Also</h2> +<p><a class="link" href="SpiceRecordChannel.html" title="Record Channel"><span class="type">SpiceRecordChannel</span></a>, and <a class="link" href="SpicePlaybackChannel.html" title="Playback Channel"><span class="type">SpicePlaybackChannel</span></a></p> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/SpiceChannel.html b/content-extra/api/spice-gtk/SpiceChannel.html new file mode 100644 index 0000000..ff3493a --- /dev/null +++ b/content-extra/api/spice-gtk/SpiceChannel.html @@ -0,0 +1,967 @@ +<!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 Channel: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="ch02.html" title="Session and Channels Objects, from spice-client-glib"> +<link rel="prev" href="SpiceSession.html" title="Spice Session"> +<link rel="next" href="SpiceCursorChannel.html" title="Cursor Channel"> +<meta name="generator" content="GTK-Doc V1.24 (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="#SpiceChannel.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#SpiceChannel.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#SpiceChannel.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> + <a href="#SpiceChannel.signals" class="shortcut">Signals</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="SpiceSession.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="SpiceCursorChannel.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="SpiceChannel"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="SpiceChannel.top_of_page"></a>Spice Channel</span></h2> +<p>Spice Channel — the base channel class</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="SpiceChannel.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="SpiceChannel.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="returnvalue">SpiceChannel</span></a> * +</td> +<td class="function_name"> +<a class="link" href="SpiceChannel.html#spice-channel-new" title="spice_channel_new ()">spice_channel_new</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="SpiceChannel.html#spice-channel-destroy" title="spice_channel_destroy ()">spice_channel_destroy</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceChannel.html#spice-channel-connect" title="spice_channel_connect ()">spice_channel_connect</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceChannel.html#spice-channel-open-fd" title="spice_channel_open_fd ()">spice_channel_open_fd</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="SpiceChannel.html#spice-channel-disconnect" title="spice_channel_disconnect ()">spice_channel_disconnect</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceChannel.html#spice-channel-test-capability" title="spice_channel_test_capability ()">spice_channel_test_capability</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceChannel.html#spice-channel-test-common-capability" title="spice_channel_test_common_capability ()">spice_channel_test_common_capability</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +</td> +<td class="function_name"> +<a class="link" href="SpiceChannel.html#spice-channel-type-to-string" title="spice_channel_type_to_string ()">spice_channel_type_to_string</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceChannel.html#spice-channel-string-to-type" title="spice_channel_string_to_type ()">spice_channel_string_to_type</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="SpiceChannel.html#spice-channel-set-capability" title="spice_channel_set_capability ()">spice_channel_set_capability</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="SpiceChannel.html#spice-channel-flush-async" title="spice_channel_flush_async ()">spice_channel_flush_async</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceChannel.html#spice-channel-flush-finish" title="spice_channel_flush_finish ()">spice_channel_flush_finish</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> * +</td> +<td class="function_name"> +<a class="link" href="SpiceChannel.html#spice-channel-get-error" title="spice_channel_get_error ()">spice_channel_get_error</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceChannel.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> +<td class="property_name"><a class="link" href="SpiceChannel.html#SpiceChannel--channel-id" title="The “channel-id” property">channel-id</a></td> +<td class="property_flags">Read / Write / Construct Only</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> +<td class="property_name"><a class="link" href="SpiceChannel.html#SpiceChannel--channel-type" title="The “channel-type” property">channel-type</a></td> +<td class="property_flags">Read / Write / Construct Only</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> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a></td> +<td class="property_name"><a class="link" href="SpiceChannel.html#SpiceChannel--total-read-bytes" title="The “total-read-bytes” property">total-read-bytes</a></td> +<td class="property_flags">Read</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceChannel.signals"></a><h2>Signals</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="signals_return"> +<col width="300px" class="signals_name"> +<col width="200px" class="signals_flags"> +</colgroup> +<tbody> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceChannel.html#SpiceChannel-channel-event" title="The “channel-event” signal">channel-event</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceChannel.html#SpiceChannel-open-fd" title="The “open-fd” signal">open-fd</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceChannel.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table 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="SpiceChannel.html#SpiceChannelEvent" title="enum SpiceChannelEvent">SpiceChannelEvent</a></td> +</tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="SpiceChannel.html#SpiceChannel-struct" title="SpiceChannel">SpiceChannel</a></td> +</tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="SpiceChannel.html#SpiceChannelClass" title="SpiceChannelClass">SpiceChannelClass</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceChannel.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a> + <span class="lineart">╰──</span> SpiceChannelEvent + <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">╰──</span> SpiceChannel + <span class="lineart">├──</span> <a class="link" href="SpiceCursorChannel.html" title="Cursor Channel">SpiceCursorChannel</a> + <span class="lineart">├──</span> <a class="link" href="SpiceDisplayChannel.html" title="Display Channel">SpiceDisplayChannel</a> + <span class="lineart">├──</span> <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel">SpiceInputsChannel</a> + <span class="lineart">├──</span> <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> + <span class="lineart">├──</span> <a class="link" href="SpicePlaybackChannel.html" title="Playback Channel">SpicePlaybackChannel</a> + <span class="lineart">├──</span> <a class="link" href="SpiceRecordChannel.html" title="Record Channel">SpiceRecordChannel</a> + <span class="lineart">├──</span> <a class="link" href="SpiceSmartcardChannel.html" title="Smartcard Channel">SpiceSmartcardChannel</a> + <span class="lineart">├──</span> <a class="link" href="SpiceUsbredirChannel.html" title="USB Redirection Channel">SpiceUsbredirChannel</a> + <span class="lineart">╰──</span> <a class="link" href="SpicePortChannel.html" title="Port Channel">SpicePortChannel</a> +</pre> +</div> +<div class="refsect1"> +<a name="SpiceChannel.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-client.h> +</pre> +</div> +<div class="refsect1"> +<a name="SpiceChannel.description"></a><h2>Description</h2> +<p><a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a> is the base class for the different kind of Spice +channel connections, such as <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a>, or +<a class="link" href="SpiceInputsChannel.html" title="Inputs Channel"><span class="type">SpiceInputsChannel</span></a>.</p> +</div> +<div class="refsect1"> +<a name="SpiceChannel.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="spice-channel-new"></a><h3>spice_channel_new ()</h3> +<pre class="programlisting"><a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="returnvalue">SpiceChannel</span></a> * +spice_channel_new (<em class="parameter"><code><a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> *s</code></em>, + <em class="parameter"><code><span class="type">int</span> type</code></em>, + <em class="parameter"><code><span class="type">int</span> id</code></em>);</pre> +<p>Create a new <a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a> of type <em class="parameter"><code>type</code></em> +, and channel ID <em class="parameter"><code>id</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.2.3.3.11.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>s</p></td> +<td class="parameter_description"><p>the <em class="parameter"><code>SpiceSession</code></em> +the channel is linked to</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>type</p></td> +<td class="parameter_description"><p>the requested SPICECHANNELPRIVATE type</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>id</p></td> +<td class="parameter_description"><p>the channel-id</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.3.3.11.2.6"></a><h4>Returns</h4> +<p> a weak reference to <a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a>, the session owns the reference</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-channel-destroy"></a><h3>spice_channel_destroy ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_channel_destroy (<em class="parameter"><code><a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a> *channel</code></em>);</pre> +<div class="warning"> +<p><code class="literal">spice_channel_destroy</code> has been deprecated since version 0.27 and should not be used in newly-written code.</p> +<p>this function has been deprecated because it is +misleading, the object is not actually destroyed. Instead, it is +recommended to call explicitely <a class="link" href="SpiceChannel.html#spice-channel-disconnect" title="spice_channel_disconnect ()"><code class="function">spice_channel_disconnect()</code></a> and +<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.</p> +</div> +<p>Disconnect and unref the <em class="parameter"><code>channel</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.2.3.3.11.3.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-channel-connect"></a><h3>spice_channel_connect ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +spice_channel_connect (<em class="parameter"><code><a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a> *channel</code></em>);</pre> +<p>Connect the channel, using <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> connection informations</p> +<div class="refsect3"> +<a name="id-1.2.3.3.11.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.3.3.11.4.6"></a><h4>Returns</h4> +<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-channel-open-fd"></a><h3>spice_channel_open_fd ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +spice_channel_open_fd (<em class="parameter"><code><a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a> *channel</code></em>, + <em class="parameter"><code><span class="type">int</span> fd</code></em>);</pre> +<p>Connect the channel using <em class="parameter"><code>fd</code></em> + socket.</p> +<p>If <em class="parameter"><code>fd</code></em> + is -1, a valid fd will be requested later via the +SpiceChannel::open-fd signal.</p> +<div class="refsect3"> +<a name="id-1.2.3.3.11.5.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>fd</p></td> +<td class="parameter_description"><p>a file descriptor (socket) or -1. +request mechanism</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.3.3.11.5.7"></a><h4>Returns</h4> +<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-channel-disconnect"></a><h3>spice_channel_disconnect ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_channel_disconnect (<em class="parameter"><code><a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a class="link" href="SpiceChannel.html#SpiceChannelEvent" title="enum SpiceChannelEvent"><span class="type">SpiceChannelEvent</span></a> reason</code></em>);</pre> +<p>Close the socket and reset connection specific data. Finally, emit +<em class="parameter"><code>reason</code></em> + <a class="link" href="SpiceChannel.html#SpiceChannel-channel-event" title="The “channel-event” signal"><span class="type">“channel-event”</span></a> on main context if not +<a class="link" href="SpiceChannel.html#SPICE-CHANNEL-NONE:CAPS"><span class="type">SPICE_CHANNEL_NONE</span></a>.</p> +<div class="refsect3"> +<a name="id-1.2.3.3.11.6.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>reason</p></td> +<td class="parameter_description"><p>a channel event emitted on main context (or <a class="link" href="SpiceChannel.html#SPICE-CHANNEL-NONE:CAPS"><span class="type">SPICE_CHANNEL_NONE</span></a>)</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-channel-test-capability"></a><h3>spice_channel_test_capability ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +spice_channel_test_capability (<em class="parameter"><code><a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> cap</code></em>);</pre> +<p>Test availability of remote "channel kind capability".</p> +<div class="refsect3"> +<a name="id-1.2.3.3.11.7.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cap</p></td> +<td class="parameter_description"><p>a capability</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.3.3.11.7.6"></a><h4>Returns</h4> +<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>cap</code></em> +(channel kind capability) is available.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-channel-test-common-capability"></a><h3>spice_channel_test_common_capability ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +spice_channel_test_common_capability (<em class="parameter"><code><a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> cap</code></em>);</pre> +<p>Test availability of remote "common channel capability".</p> +<div class="refsect3"> +<a name="id-1.2.3.3.11.8.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cap</p></td> +<td class="parameter_description"><p>a capability</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.3.3.11.8.6"></a><h4>Returns</h4> +<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>cap</code></em> +(common channel capability) is available.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-channel-type-to-string"></a><h3>spice_channel_type_to_string ()</h3> +<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +spice_channel_type_to_string (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> type</code></em>);</pre> +<p>Convert a channel-type property value to a string.</p> +<div class="refsect3"> +<a name="id-1.2.3.3.11.9.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>type</p></td> +<td class="parameter_description"><p>a channel-type property value</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.3.3.11.9.6"></a><h4>Returns</h4> +<p> string representation of <em class="parameter"><code>type</code></em> +.</p> +</div> +<p class="since">Since: 0.20</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-channel-string-to-type"></a><h3>spice_channel_string_to_type ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> +spice_channel_string_to_type (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *str</code></em>);</pre> +<p>Convert a channel-type property value to a string.</p> +<div class="refsect3"> +<a name="id-1.2.3.3.11.10.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 representation of the channel-type property</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.3.3.11.10.6"></a><h4>Returns</h4> +<p> the channel-type property value for a <em class="parameter"><code>str</code></em> +channel</p> +</div> +<p class="since">Since: 0.21</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-channel-set-capability"></a><h3>spice_channel_set_capability ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_channel_set_capability (<em class="parameter"><code><a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> cap</code></em>);</pre> +<div class="warning"> +<p><code class="literal">spice_channel_set_capability</code> has been deprecated since version 0.13 and should not be used in newly-written code.</p> +<p>this function has been removed</p> +</div> +<p>Enable specific channel-kind capability.</p> +<div class="refsect3"> +<a name="id-1.2.3.3.11.11.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cap</p></td> +<td class="parameter_description"><p>a capability</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-channel-flush-async"></a><h3>spice_channel_flush_async ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_channel_flush_async (<em class="parameter"><code><a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> +<p>Forces an asynchronous write of all user-space buffered data for +the given channel.</p> +<p>When the operation is finished callback will be called. You can +then call <a class="link" href="SpiceChannel.html#spice-channel-flush-finish" title="spice_channel_flush_finish ()"><code class="function">spice_channel_flush_finish()</code></a> to get the result of the +operation.</p> +<div class="refsect3"> +<a name="id-1.2.3.3.11.12.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> optional GCancellable object, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </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> +<tr> +<td class="parameter_name"><p>callback</p></td> +<td class="parameter_description"><p> callback to call when the request is satisfied. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p> the data to pass to callback function. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: 0.15</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-channel-flush-finish"></a><h3>spice_channel_flush_finish ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +spice_channel_flush_finish (<em class="parameter"><code><a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Finishes flushing a channel.</p> +<div class="refsect3"> +<a name="id-1.2.3.3.11.13.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>result</p></td> +<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> location to store the error occurring, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> +to ignore.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.3.3.11.13.6"></a><h4>Returns</h4> +<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if flush operation succeeded, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p> +</div> +<p class="since">Since: 0.15</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-channel-get-error"></a><h3>spice_channel_get_error ()</h3> +<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> * +spice_channel_get_error (<em class="parameter"><code><a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a> *channel</code></em>);</pre> +<p>Retrieves the <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> currently set on channel, if the <a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a> +is in error state and can provide additional error details.</p> +<div class="refsect3"> +<a name="id-1.2.3.3.11.14.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.3.3.11.14.6"></a><h4>Returns</h4> +<p> the pointer to the error, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p> +</div> +<p class="since">Since: 0.24</p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceChannel.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SpiceChannelEvent"></a><h3>enum SpiceChannelEvent</h3> +<p>An event, emitted by <a class="link" href="SpiceChannel.html#SpiceChannel-channel-event" title="The “channel-event” signal"><span class="type">“channel-event”</span></a> signal.</p> +<div class="refsect3"> +<a name="id-1.2.3.3.12.2.4"></a><h4>Members</h4> +<div class="informaltable"><table 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-CHANNEL-NONE:CAPS"></a>SPICE_CHANNEL_NONE</p></td> +<td class="enum_member_description"> +<p>no event, or ignored event</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="SPICE-CHANNEL-OPENED:CAPS"></a>SPICE_CHANNEL_OPENED</p></td> +<td class="enum_member_description"> +<p>connection is authentified and ready</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="SPICE-CHANNEL-SWITCHING:CAPS"></a>SPICE_CHANNEL_SWITCHING</p></td> +<td class="enum_member_description"> +<p>disconnecting from the current host and connecting to the target host.</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="SPICE-CHANNEL-CLOSED:CAPS"></a>SPICE_CHANNEL_CLOSED</p></td> +<td class="enum_member_description"> +<p>connection is closed normally (sent if channel was ready)</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="SPICE-CHANNEL-ERROR-CONNECT:CAPS"></a>SPICE_CHANNEL_ERROR_CONNECT</p></td> +<td class="enum_member_description"> +<p>connection error</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="SPICE-CHANNEL-ERROR-TLS:CAPS"></a>SPICE_CHANNEL_ERROR_TLS</p></td> +<td class="enum_member_description"> +<p>SSL error</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="SPICE-CHANNEL-ERROR-LINK:CAPS"></a>SPICE_CHANNEL_ERROR_LINK</p></td> +<td class="enum_member_description"> +<p>error during link process</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="SPICE-CHANNEL-ERROR-AUTH:CAPS"></a>SPICE_CHANNEL_ERROR_AUTH</p></td> +<td class="enum_member_description"> +<p>authentication error</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="SPICE-CHANNEL-ERROR-IO:CAPS"></a>SPICE_CHANNEL_ERROR_IO</p></td> +<td class="enum_member_description"> +<p>IO error</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceChannel-struct"></a><h3>SpiceChannel</h3> +<pre class="programlisting">typedef struct _SpiceChannel SpiceChannel;</pre> +<p>The <a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a> struct is opaque and should not be accessed directly.</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceChannelClass"></a><h3>SpiceChannelClass</h3> +<pre class="programlisting">typedef struct { + GObjectClass parent_class; + + /* signals, main context */ + void (*channel_event)(SpiceChannel *channel, SpiceChannelEvent event); + void (*open_fd)(SpiceChannel *channel, int with_tls); +} SpiceChannelClass; +</pre> +<p>Class structure for <a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a>.</p> +<div class="refsect3"> +<a name="id-1.2.3.3.12.4.5"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="SpiceChannelClass.parent-class"></a>parent_class</code></em>;</p></td> +<td class="struct_member_description"><p>Parent class.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceChannelClass.channel-event"></a>channel_event</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceChannel.html#SpiceChannel-channel-event" title="The “channel-event” signal"><span class="type">“channel_event”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceChannelClass.open-fd"></a>open_fd</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceChannel.html#SpiceChannel-open-fd" title="The “open-fd” signal"><span class="type">“open_fd”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="SpiceChannel.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="SpiceChannel--channel-id"></a><h3>The <code class="literal">“channel-id”</code> property</h3> +<pre class="programlisting"> “channel-id” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> +<p>Channel ID.</p> +<p>Flags: Read / Write / Construct Only</p> +<p>Allowed values: >= -1</p> +<p>Default value: -1</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceChannel--channel-type"></a><h3>The <code class="literal">“channel-type”</code> property</h3> +<pre class="programlisting"> “channel-type” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> +<p>Channel type.</p> +<p>Flags: Read / Write / Construct Only</p> +<p>Allowed values: >= -1</p> +<p>Default value: -1</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> +<p>Flags: Read / Write / Construct Only</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceChannel--total-read-bytes"></a><h3>The <code class="literal">“total-read-bytes”</code> property</h3> +<pre class="programlisting"> “total-read-bytes” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a></pre> +<p>Total read bytes.</p> +<p>Flags: Read</p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceChannel.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="SpiceChannel-channel-event"></a><h3>The <code class="literal">“channel-event”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a> *channel, + <a class="link" href="SpiceChannel.html#SpiceChannelEvent" title="enum SpiceChannelEvent"><span class="type">SpiceChannelEvent</span></a> event, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpiceChannel.html#SpiceChannel-channel-event" title="The “channel-event” signal"><span class="type">“channel-event”</span></a> signal is emitted when the +state of the connection is changed. In case of errors, +<a class="link" href="SpiceChannel.html#spice-channel-get-error" title="spice_channel_get_error ()"><code class="function">spice_channel_get_error()</code></a> may provide additional informations +on the source of the error.</p> +<div class="refsect3"> +<a name="id-1.2.3.3.14.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>the channel that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>event</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceChannel.html#SpiceChannelEvent" title="enum SpiceChannelEvent"><span class="type">SpiceChannelEvent</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceChannel-open-fd"></a><h3>The <code class="literal">“open-fd”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a> *channel, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> with_tls, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpiceChannel.html#SpiceChannel-open-fd" title="The “open-fd” signal"><span class="type">“open-fd”</span></a> signal is emitted when a new +connection is requested. This signal is emitted when the +connection is made with <a class="link" href="SpiceSession.html#spice-session-open-fd" title="spice_session_open_fd ()"><code class="function">spice_session_open_fd()</code></a>.</p> +<div class="refsect3"> +<a name="id-1.2.3.3.14.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>the channel that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>with_tls</p></td> +<td class="parameter_description"><p>wether TLS connection is requested</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceChannel.see-also"></a><h2>See Also</h2> +<p><a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a>, <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> and other channels</p> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/SpiceCursorChannel.html b/content-extra/api/spice-gtk/SpiceCursorChannel.html new file mode 100644 index 0000000..d682424 --- /dev/null +++ b/content-extra/api/spice-gtk/SpiceCursorChannel.html @@ -0,0 +1,364 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Cursor Channel: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="ch02.html" title="Session and Channels Objects, from spice-client-glib"> +<link rel="prev" href="SpiceChannel.html" title="Spice Channel"> +<link rel="next" href="SpiceDisplayChannel.html" title="Display Channel"> +<meta name="generator" content="GTK-Doc V1.24 (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="#SpiceCursorChannel.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#SpiceCursorChannel.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals"> <span class="dim">|</span> + <a href="#SpiceCursorChannel.signals" class="shortcut">Signals</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="SpiceChannel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="SpiceDisplayChannel.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="SpiceCursorChannel"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="SpiceCursorChannel.top_of_page"></a>Cursor Channel</span></h2> +<p>Cursor Channel — update cursor shape and position</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="SpiceCursorChannel.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="SpiceCursorChannel.signals"></a><h2>Signals</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="signals_return"> +<col width="300px" class="signals_name"> +<col width="200px" class="signals_flags"> +</colgroup> +<tbody> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceCursorChannel.html#SpiceCursorChannel-cursor-hide" title="The “cursor-hide” signal">cursor-hide</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceCursorChannel.html#SpiceCursorChannel-cursor-move" title="The “cursor-move” signal">cursor-move</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceCursorChannel.html#SpiceCursorChannel-cursor-reset" title="The “cursor-reset” signal">cursor-reset</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceCursorChannel.html#SpiceCursorChannel-cursor-set" title="The “cursor-set” signal">cursor-set</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceCursorChannel.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceCursorChannel.html#SpiceCursorChannel-struct" title="struct SpiceCursorChannel">SpiceCursorChannel</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceCursorChannel.html#SpiceCursorChannelClass" title="struct SpiceCursorChannelClass">SpiceCursorChannelClass</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceCursorChannel.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">╰──</span> <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> + <span class="lineart">╰──</span> SpiceCursorChannel +</pre> +</div> +<div class="refsect1"> +<a name="SpiceCursorChannel.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-client.h> +</pre> +</div> +<div class="refsect1"> +<a name="SpiceCursorChannel.description"></a><h2>Description</h2> +<p>The Spice protocol defines a set of messages for controlling cursor +shape and position on the remote display area. The cursor changes +that should be reflected on the display are notified by +signals. See for example <a class="link" href="SpiceCursorChannel.html#SpiceCursorChannel-cursor-set" title="The “cursor-set” signal"><span class="type">“cursor-set”</span></a> +<a class="link" href="SpiceCursorChannel.html#SpiceCursorChannel-cursor-move" title="The “cursor-move” signal"><span class="type">“cursor-move”</span></a> signals.</p> +</div> +<div class="refsect1"> +<a name="SpiceCursorChannel.functions_details"></a><h2>Functions</h2> +<p></p> +</div> +<div class="refsect1"> +<a name="SpiceCursorChannel.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SpiceCursorChannel-struct"></a><h3>struct SpiceCursorChannel</h3> +<pre class="programlisting">struct SpiceCursorChannel;</pre> +<p>The <a class="link" href="SpiceCursorChannel.html" title="Cursor Channel"><span class="type">SpiceCursorChannel</span></a> struct is opaque and should not be accessed directly.</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceCursorChannelClass"></a><h3>struct SpiceCursorChannelClass</h3> +<pre class="programlisting">struct SpiceCursorChannelClass { + SpiceChannelClass parent_class; + + /* signals */ + void (*cursor_set)(SpiceCursorChannel *channel, gint width, gint height, + gint hot_x, gint hot_y, gpointer rgba); + void (*cursor_move)(SpiceCursorChannel *channel, gint x, gint y); + void (*cursor_hide)(SpiceCursorChannel *channel); + void (*cursor_reset)(SpiceCursorChannel *channel); +}; +</pre> +<p>Class structure for <a class="link" href="SpiceCursorChannel.html" title="Cursor Channel"><span class="type">SpiceCursorChannel</span></a>.</p> +<div class="refsect3"> +<a name="id-1.2.3.4.10.3.5"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="struct_member_name"><p><a class="link" href="SpiceChannel.html#SpiceChannelClass" title="SpiceChannelClass"><span class="type">SpiceChannelClass</span></a> <em class="structfield"><code><a name="SpiceCursorChannelClass.parent-class"></a>parent_class</code></em>;</p></td> +<td class="struct_member_description"><p>Parent class.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceCursorChannelClass.cursor-set"></a>cursor_set</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceCursorChannel.html#SpiceCursorChannel-cursor-set" title="The “cursor-set” signal"><span class="type">“cursor-set”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceCursorChannelClass.cursor-move"></a>cursor_move</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceCursorChannel.html#SpiceCursorChannel-cursor-move" title="The “cursor-move” signal"><span class="type">“cursor-move”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceCursorChannelClass.cursor-hide"></a>cursor_hide</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceCursorChannel.html#SpiceCursorChannel-cursor-hide" title="The “cursor-hide” signal"><span class="type">“cursor-hide”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceCursorChannelClass.cursor-reset"></a>cursor_reset</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceCursorChannel.html#SpiceCursorChannel-cursor-reset" title="The “cursor-reset” signal"><span class="type">“cursor-reset”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="SpiceCursorChannel.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="SpiceCursorChannel-cursor-hide"></a><h3>The <code class="literal">“cursor-hide”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceCursorChannel.html" title="Cursor Channel"><span class="type">SpiceCursorChannel</span></a> *cursor, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpiceCursorChannel.html#SpiceCursorChannel-cursor-hide" title="The “cursor-hide” signal"><span class="type">“cursor-hide”</span></a> signal is emitted to hide +the cursor/pointer on the display area.</p> +<div class="refsect3"> +<a name="id-1.2.3.4.11.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>cursor</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceCursorChannel.html" title="Cursor Channel"><span class="type">SpiceCursorChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceCursorChannel-cursor-move"></a><h3>The <code class="literal">“cursor-move”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceCursorChannel.html" title="Cursor Channel"><span class="type">SpiceCursorChannel</span></a> *cursor, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpiceCursorChannel.html#SpiceCursorChannel-cursor-move" title="The “cursor-move” signal"><span class="type">“cursor-move”</span></a> signal is emitted to update +the cursor position on the display area.</p> +<div class="refsect3"> +<a name="id-1.2.3.4.11.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>cursor</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceCursorChannel.html" title="Cursor Channel"><span class="type">SpiceCursorChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>x</p></td> +<td class="parameter_description"><p>x position</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>y</p></td> +<td class="parameter_description"><p>y position</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceCursorChannel-cursor-reset"></a><h3>The <code class="literal">“cursor-reset”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceCursorChannel.html" title="Cursor Channel"><span class="type">SpiceCursorChannel</span></a> *cursor, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpiceCursorChannel.html#SpiceCursorChannel-cursor-reset" title="The “cursor-reset” signal"><span class="type">“cursor-reset”</span></a> signal is emitted to +reset the cursor to its default context.</p> +<div class="refsect3"> +<a name="id-1.2.3.4.11.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>cursor</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceCursorChannel.html" title="Cursor Channel"><span class="type">SpiceCursorChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceCursorChannel-cursor-set"></a><h3>The <code class="literal">“cursor-set”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceCursorChannel.html" title="Cursor Channel"><span class="type">SpiceCursorChannel</span></a> *cursor, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> hot_x, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> hot_y, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> rgba, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpiceCursorChannel.html#SpiceCursorChannel-cursor-set" title="The “cursor-set” signal"><span class="type">“cursor-set”</span></a> signal is emitted to modify +cursor aspect and position on the display area.</p> +<div class="refsect3"> +<a name="id-1.2.3.4.11.5.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>cursor</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceCursorChannel.html" title="Cursor Channel"><span class="type">SpiceCursorChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>width</p></td> +<td class="parameter_description"><p>width of the shape</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>height</p></td> +<td class="parameter_description"><p>height of the shape</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>hot_x</p></td> +<td class="parameter_description"><p>horizontal offset of the 'hotspot' of the cursor</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>hot_y</p></td> +<td class="parameter_description"><p>vertical offset of the 'hotspot' of the cursor</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>rgba</p></td> +<td class="parameter_description"><p>32bits shape data, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if default cursor. It might +be freed after the signal is emitted, so make sure to copy it +if you need it later!</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceCursorChannel.see-also"></a><h2>See Also</h2> +<p><a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a>, and the GTK widget <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a></p> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/SpiceDisplay.html b/content-extra/api/spice-gtk/SpiceDisplay.html new file mode 100644 index 0000000..2ea5f05 --- /dev/null +++ b/content-extra/api/spice-gtk/SpiceDisplay.html @@ -0,0 +1,1094 @@ +<!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.78.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="SpiceGtkSession.html" title="Spice GTK Session"> +<link rel="next" href="SpiceUsbDeviceWidget.html" title="Spice USB device selection widget"> +<meta name="generator" content="GTK-Doc V1.24 (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="#SpiceDisplay.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#SpiceDisplay.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> + <a href="#SpiceDisplay.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#SpiceDisplay.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> + <a href="#SpiceDisplay.signals" class="shortcut">Signals</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="SpiceGtkSession.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="SpiceUsbDeviceWidget.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="SpiceDisplay"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="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="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="SpiceDisplay.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="returnvalue">SpiceDisplay</span></a> * +</td> +<td class="function_name"> +<a class="link" href="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"> +<a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="returnvalue">SpiceDisplay</span></a> * +</td> +<td class="function_name"> +<a class="link" href="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="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="SpiceDisplay.html#spice-display-copy-to-guest" title="spice_display_copy_to_guest ()">spice_display_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="SpiceDisplay.html#spice-display-paste-from-guest" title="spice_display_paste_from_guest ()">spice_display_paste_from_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="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="SpiceDisplay.html#SpiceGrabSequence"><span class="returnvalue">SpiceGrabSequence</span></a> * +</td> +<td class="function_name"> +<a class="link" href="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="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"> +<span class="returnvalue">GdkPixbuf</span> * +</td> +<td class="function_name"> +<a class="link" href="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="SpiceDisplay.html#SpiceGrabSequence"><span class="returnvalue">SpiceGrabSequence</span></a> * +</td> +<td class="function_name"> +<a class="link" href="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="SpiceDisplay.html#SpiceGrabSequence"><span class="returnvalue">SpiceGrabSequence</span></a> * +</td> +<td class="function_name"> +<a class="link" href="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="SpiceDisplay.html#SpiceGrabSequence"><span class="returnvalue">SpiceGrabSequence</span></a> * +</td> +<td class="function_name"> +<a class="link" href="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="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/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +</td> +<td class="function_name"> +<a class="link" href="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> +<div class="refsect1"> +<a name="SpiceDisplay.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceDisplay.html#SpiceDisplay--auto-clipboard" title="The “auto-clipboard” property">auto-clipboard</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> +<td class="property_name"><a class="link" href="SpiceDisplay.html#SpiceDisplay--channel-id" title="The “channel-id” property">channel-id</a></td> +<td class="property_flags">Read / Write / Construct Only</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceDisplay.html#SpiceDisplay--disable-inputs" title="The “disable-inputs” property">disable-inputs</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceDisplay.html#SpiceDisplay--grab-keyboard" title="The “grab-keyboard” property">grab-keyboard</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceDisplay.html#SpiceDisplay--grab-mouse" title="The “grab-mouse” property">grab-mouse</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> +<td class="property_name"><a class="link" href="SpiceDisplay.html#SpiceDisplay--keypress-delay" title="The “keypress-delay” property">keypress-delay</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> +<td class="property_name"><a class="link" href="SpiceDisplay.html#SpiceDisplay--monitor-id" title="The “monitor-id” property">monitor-id</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceDisplay.html#SpiceDisplay--only-downscale" title="The “only-downscale” property">only-downscale</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceDisplay.html#SpiceDisplay--ready" title="The “ready” property">ready</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceDisplay.html#SpiceDisplay--resize-guest" title="The “resize-guest” property">resize-guest</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceDisplay.html#SpiceDisplay--scaling" title="The “scaling” property">scaling</a></td> +<td class="property_flags">Read / Write / Construct</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="SpiceDisplay.html#SpiceDisplay--session" title="The “session” property">session</a></td> +<td class="property_flags">Read / Write / Construct Only</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> +<td class="property_name"><a class="link" href="SpiceDisplay.html#SpiceDisplay--zoom-level" title="The “zoom-level” property">zoom-level</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceDisplay.signals"></a><h2>Signals</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="signals_return"> +<col width="300px" class="signals_name"> +<col width="200px" class="signals_flags"> +</colgroup> +<tbody> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceDisplay.html#SpiceDisplay-grab-keys-pressed" title="The “grab-keys-pressed” signal">grab-keys-pressed</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceDisplay.html#SpiceDisplay-keyboard-grab" title="The “keyboard-grab” signal">keyboard-grab</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceDisplay.html#SpiceDisplay-mouse-grab" title="The “mouse-grab” signal">mouse-grab</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +</tbody> +</table></div> +</div> +<a name="SpiceGrabSequence"></a><div class="refsect1"> +<a name="SpiceDisplay.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceDisplay.html#SpiceDisplay-struct" title="struct SpiceDisplay">SpiceDisplay</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceDisplay.html#SpiceDisplayClass" title="struct SpiceDisplayClass">SpiceDisplayClass</a></td> +</tr> +<tr> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="SpiceDisplay.html#SpiceDisplayKeyEvent" title="enum SpiceDisplayKeyEvent">SpiceDisplayKeyEvent</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceDisplay.html#SpiceGrabSequence-struct" title="struct SpiceGrabSequence">SpiceGrabSequence</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="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 + <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> + <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk2/GtkWidget.html">GtkWidget</a> + <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk2/GtkDrawingArea.html">GtkDrawingArea</a> + <span class="lineart">╰──</span> SpiceDisplay +</pre> +</div> +<div class="refsect1"> +<a name="SpiceDisplay.implemented-interfaces"></a><h2>Implemented Interfaces</h2> +<p> +SpiceDisplay implements + AtkImplementorIface and <a href="/usr/share/gtk-doc/html/gtk2/GtkBuildable.html">GtkBuildable</a>.</p> +</div> +<div class="refsect1"> +<a name="SpiceDisplay.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-client-gtk.h> +</pre> +</div> +<div class="refsect1"> +<a name="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="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 <a class="link" href="SpiceDisplay.html#SpiceDisplay--grab-keyboard" title="The “grab-keyboard” property"><span class="type">“grab-keyboard”</span></a> and +<a class="link" href="SpiceDisplay.html#SpiceDisplay--grab-mouse" title="The “grab-mouse” property"><span class="type">“grab-mouse”</span></a> are <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> respectively. It can be +ungrabbed with <a class="link" href="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="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="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 <span class="type">GdkPixbuf</span> (that you can then easily +save to disk).</p> +</div> +<div class="refsect1"> +<a name="SpiceDisplay.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="spice-display-new"></a><h3>spice_display_new ()</h3> +<pre class="programlisting"><a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="returnvalue">SpiceDisplay</span></a> * +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 <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a> widget.</p> +<div class="refsect3"> +<a name="id-1.2.4.3.13.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.4.3.13.2.6"></a><h4>Returns</h4> +<p> a new <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a> 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"><a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="returnvalue">SpiceDisplay</span></a> * +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/glib/glib-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/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> monitor_id</code></em>);</pre> +<p>Creates a new <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a> widget associated with the monitor id.</p> +<div class="refsect3"> +<a name="id-1.2.4.3.13.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a></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="id-1.2.4.3.13.3.6"></a><h4>Returns</h4> +<p> a new <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a> 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><a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a> *display</code></em>);</pre> +<p>Ungrab the mouse.</p> +<div class="refsect3"> +<a name="id-1.2.4.3.13.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-display-copy-to-guest"></a><h3>spice_display_copy_to_guest ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_display_copy_to_guest (<em class="parameter"><code><a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a> *display</code></em>);</pre> +<div class="warning"> +<p><code class="literal">spice_display_copy_to_guest</code> has been deprecated since version 0.8 and should not be used in newly-written code.</p> +<p>Use <a class="link" href="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> instead</p> +</div> +<p>Copy client-side clipboard to guest clipboard.</p> +<div class="refsect3"> +<a name="id-1.2.4.3.13.5.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-display-paste-from-guest"></a><h3>spice_display_paste_from_guest ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_display_paste_from_guest (<em class="parameter"><code><a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a> *display</code></em>);</pre> +<div class="warning"> +<p><code class="literal">spice_display_paste_from_guest</code> has been deprecated since version 0.8 and should not be used in newly-written code.</p> +<p>Use <a class="link" href="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> instead</p> +</div> +<p>Copy guest clipboard to client-side clipboard.</p> +<div class="refsect3"> +<a name="id-1.2.4.3.13.6.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a></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><a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a> *display</code></em>, + <em class="parameter"><code><a class="link" href="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="id-1.2.4.3.13.7.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="SpiceDisplay.html#SpiceGrabSequence"><span class="returnvalue">SpiceGrabSequence</span></a> * +spice_display_get_grab_keys (<em class="parameter"><code><a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a> *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="id-1.2.4.3.13.8.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="id-1.2.4.3.13.8.6"></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><a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a> *display</code></em>, + <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-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="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="id-1.2.4.3.13.9.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a></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="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"><span class="returnvalue">GdkPixbuf</span> * +spice_display_get_pixbuf (<em class="parameter"><code><a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a> *display</code></em>);</pre> +<p>Take a screenshot of the display.</p> +<div class="refsect3"> +<a name="id-1.2.4.3.13.10.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.4.3.13.10.6"></a><h4>Returns</h4> +<p> a <span class="type">GdkPixbuf</span> 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="SpiceDisplay.html#SpiceGrabSequence"><span class="returnvalue">SpiceGrabSequence</span></a> * +spice_grab_sequence_new (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> nkeysyms</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-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="id-1.2.4.3.13.11.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="id-1.2.4.3.13.11.6"></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="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/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *str</code></em>);</pre> +<p>Creates a new <a class="link" href="SpiceDisplay.html#SpiceGrabSequence"><span class="type">SpiceGrabSequence</span></a> from the string representation.</p> +<div class="refsect3"> +<a name="id-1.2.4.3.13.12.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="id-1.2.4.3.13.12.6"></a><h4>Returns</h4> +<p> a new <a class="link" href="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="SpiceDisplay.html#SpiceGrabSequence"><span class="returnvalue">SpiceGrabSequence</span></a> * +spice_grab_sequence_copy (<em class="parameter"><code><a class="link" href="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="id-1.2.4.3.13.13.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="id-1.2.4.3.13.13.6"></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="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="id-1.2.4.3.13.14.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="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/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +spice_grab_sequence_as_string (<em class="parameter"><code><a class="link" href="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="id-1.2.4.3.13.15.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="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="id-1.2.4.3.13.15.6"></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="SpiceDisplay.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SpiceDisplay-struct"></a><h3>struct SpiceDisplay</h3> +<pre class="programlisting">struct SpiceDisplay;</pre> +<p>The <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a> struct is opaque and should not be accessed directly.</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceDisplayClass"></a><h3>struct SpiceDisplayClass</h3> +<pre class="programlisting">struct SpiceDisplayClass { + GtkDrawingAreaClass parent_class; + + /* signals */ + void (*mouse_grab)(SpiceChannel *channel, gint grabbed); + void (*keyboard_grab)(SpiceChannel *channel, gint grabbed); +}; +</pre> +<p>Class structure for <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a>.</p> +<div class="refsect3"> +<a name="id-1.2.4.3.14.3.5"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="struct_member_name"><p><span class="type">GtkDrawingAreaClass</span> <em class="structfield"><code><a name="SpiceDisplayClass.parent-class"></a>parent_class</code></em>;</p></td> +<td class="struct_member_description"><p>Parent class.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceDisplayClass.mouse-grab"></a>mouse_grab</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceDisplay.html#SpiceDisplay-mouse-grab" title="The “mouse-grab” signal"><span class="type">“mouse_grab”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceDisplayClass.keyboard-grab"></a>keyboard_grab</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceDisplay.html#SpiceDisplay-keyboard-grab" title="The “keyboard-grab” signal"><span class="type">“keyboard_grab”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceDisplayKeyEvent"></a><h3>enum SpiceDisplayKeyEvent</h3> +<p>Constants for key events.</p> +<div class="refsect3"> +<a name="id-1.2.4.3.14.4.4"></a><h4>Members</h4> +<div class="informaltable"><table 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>struct SpiceGrabSequence</h3> +<pre class="programlisting">struct SpiceGrabSequence { +}; +</pre> +<p>The <a class="link" href="SpiceDisplay.html#SpiceGrabSequence"><span class="type">SpiceGrabSequence</span></a> struct is opaque and should not be accessed directly.</p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceDisplay.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="SpiceDisplay--auto-clipboard"></a><h3>The <code class="literal">“auto-clipboard”</code> property</h3> +<pre class="programlisting"> “auto-clipboard” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>When this is true the clipboard gets automatically shared between host +and guest.</p> +<div class="warning"> +<p><code class="literal">SpiceDisplay:auto-clipboard</code> has been deprecated since version 0.8 and should not be used in newly-written code.</p> +<p>Use SpiceGtkSession:auto-clipboard property instead</p> +</div> +<p>Flags: Read / Write</p> +<p>Default value: TRUE</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceDisplay--channel-id"></a><h3>The <code class="literal">“channel-id”</code> property</h3> +<pre class="programlisting"> “channel-id” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> +<p>channel-id for this <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a></p> +<p>Flags: Read / Write / Construct Only</p> +<p>Allowed values: [0,255]</p> +<p>Default value: 0</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceDisplay--disable-inputs"></a><h3>The <code class="literal">“disable-inputs”</code> property</h3> +<pre class="programlisting"> “disable-inputs” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Disable all keyboard & mouse inputs.</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: FALSE</p> +<p class="since">Since: 0.8</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceDisplay--grab-keyboard"></a><h3>The <code class="literal">“grab-keyboard”</code> property</h3> +<pre class="programlisting"> “grab-keyboard” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Whether we should grab the keyboard.</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: TRUE</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceDisplay--grab-mouse"></a><h3>The <code class="literal">“grab-mouse”</code> property</h3> +<pre class="programlisting"> “grab-mouse” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Whether we should grab the mouse.</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: TRUE</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceDisplay--keypress-delay"></a><h3>The <code class="literal">“keypress-delay”</code> property</h3> +<pre class="programlisting"> “keypress-delay” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> +<p>Delay in ms of non-modifiers key press events. If the key is +released before this delay, a single press & release event is +sent to the server. If the key is pressed longer than the +keypress-delay, the server will receive the delayed press +event, and a following release event when the key is released.</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: 100</p> +<p class="since">Since: 0.13</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceDisplay--monitor-id"></a><h3>The <code class="literal">“monitor-id”</code> property</h3> +<pre class="programlisting"> “monitor-id” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> +<p>Select monitor from <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a> to show. +The value -1 means the whole display is shown. +By default, the monitor 0 is selected.</p> +<p>Flags: Read / Write / Construct</p> +<p>Allowed values: >= -1</p> +<p>Default value: 0</p> +<p class="since">Since: 0.13</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceDisplay--only-downscale"></a><h3>The <code class="literal">“only-downscale”</code> property</h3> +<pre class="programlisting"> “only-downscale” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>If scaling, only scale down, never up.</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: FALSE</p> +<p class="since">Since: 0.14</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceDisplay--ready"></a><h3>The <code class="literal">“ready”</code> property</h3> +<pre class="programlisting"> “ready” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Indicate whether the display is ready to be shown. It takes +into account several conditions, such as the channel display +"mark" state, whether the monitor area is visible..</p> +<p>Flags: Read</p> +<p>Default value: FALSE</p> +<p class="since">Since: 0.13</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceDisplay--resize-guest"></a><h3>The <code class="literal">“resize-guest”</code> property</h3> +<pre class="programlisting"> “resize-guest” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Try to adapt guest display on window resize. Requires guest cooperation.</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: FALSE</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceDisplay--scaling"></a><h3>The <code class="literal">“scaling”</code> property</h3> +<pre class="programlisting"> “scaling” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Whether we should use scaling.</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: TRUE</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceDisplay--session"></a><h3>The <code class="literal">“session”</code> property</h3> +<pre class="programlisting"> “session” <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> *</pre> +<p><a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> for this <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a></p> +<p>Flags: Read / Write / Construct Only</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceDisplay--zoom-level"></a><h3>The <code class="literal">“zoom-level”</code> property</h3> +<pre class="programlisting"> “zoom-level” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> +<p>Zoom level in percentage, from 10 to 400. Default to 100. +(this option is only supported with cairo backend when scaling +is enabled)</p> +<p>Flags: Read / Write / Construct</p> +<p>Allowed values: [10,400]</p> +<p>Default value: 100</p> +<p class="since">Since: 0.10</p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceDisplay.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="SpiceDisplay-grab-keys-pressed"></a><h3>The <code class="literal">“grab-keys-pressed”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a> *display, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Notify when the grab keys have been pressed</p> +<div class="refsect3"> +<a name="id-1.2.4.3.16.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceDisplay-keyboard-grab"></a><h3>The <code class="literal">“keyboard-grab”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a> *display, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> status, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Notify when the keyboard grab is active or not.</p> +<div class="refsect3"> +<a name="id-1.2.4.3.16.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>status</p></td> +<td class="parameter_description"><p>1 if grabbed, 0 otherwise.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceDisplay-mouse-grab"></a><h3>The <code class="literal">“mouse-grab”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a> *display, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> status, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Notify when the mouse grab is active or not.</p> +<div class="refsect3"> +<a name="id-1.2.4.3.16.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>status</p></td> +<td class="parameter_description"><p>1 if grabbed, 0 otherwise.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/SpiceDisplayChannel.html b/content-extra/api/spice-gtk/SpiceDisplayChannel.html new file mode 100644 index 0000000..33de47c --- /dev/null +++ b/content-extra/api/spice-gtk/SpiceDisplayChannel.html @@ -0,0 +1,525 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Display Channel: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="ch02.html" title="Session and Channels Objects, from spice-client-glib"> +<link rel="prev" href="SpiceCursorChannel.html" title="Cursor Channel"> +<link rel="next" href="SpiceInputsChannel.html" title="Inputs Channel"> +<meta name="generator" content="GTK-Doc V1.24 (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="#SpiceDisplayChannel.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#SpiceDisplayChannel.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#SpiceDisplayChannel.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> + <a href="#SpiceDisplayChannel.signals" class="shortcut">Signals</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="SpiceCursorChannel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="SpiceInputsChannel.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="SpiceDisplayChannel"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="SpiceDisplayChannel.top_of_page"></a>Display Channel</span></h2> +<p>Display Channel — remote display area</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="SpiceDisplayChannel.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="SpiceDisplayChannel.functions"></a><h2>Functions</h2> +<div class="informaltable"><table 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/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceDisplayChannel.html#spice-display-get-primary" title="spice_display_get_primary ()">spice_display_get_primary</a> <span class="c_punctuation">()</span> +</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceDisplayChannel.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> +<td class="property_name"><a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel--height" title="The “height” property">height</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Arrays.html#GArray"><span class="type">GArray</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel--monitors" title="The “monitors” property">monitors</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> +<td class="property_name"><a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel--monitors-max" title="The “monitors-max” property">monitors-max</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> +<td class="property_name"><a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel--width" title="The “width” property">width</a></td> +<td class="property_flags">Read</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceDisplayChannel.signals"></a><h2>Signals</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="signals_return"> +<col width="300px" class="signals_name"> +<col width="200px" class="signals_flags"> +</colgroup> +<tbody> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel-display-invalidate" title="The “display-invalidate” signal">display-invalidate</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel-display-mark" title="The “display-mark” signal">display-mark</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel-display-primary-create" title="The “display-primary-create” signal">display-primary-create</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel-display-primary-destroy" title="The “display-primary-destroy” signal">display-primary-destroy</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceDisplayChannel.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel-struct" title="struct SpiceDisplayChannel">SpiceDisplayChannel</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannelClass" title="struct SpiceDisplayChannelClass">SpiceDisplayChannelClass</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceDisplayChannel.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">╰──</span> <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> + <span class="lineart">╰──</span> SpiceDisplayChannel +</pre> +</div> +<div class="refsect1"> +<a name="SpiceDisplayChannel.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-client.h> +</pre> +</div> +<div class="refsect1"> +<a name="SpiceDisplayChannel.description"></a><h2>Description</h2> +<p>A class that handles the rendering of the remote display and inform +of its updates.</p> +<p>The creation of the main graphic buffer is signaled with +<a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel-display-primary-create" title="The “display-primary-create” signal"><span class="type">“display-primary-create”</span></a>.</p> +<p>The update of regions is notified by +<a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel-display-invalidate" title="The “display-invalidate” signal"><span class="type">“display-invalidate”</span></a> signals.</p> +</div> +<div class="refsect1"> +<a name="SpiceDisplayChannel.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="spice-display-get-primary"></a><h3>spice_display_get_primary ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +spice_display_get_primary (<em class="parameter"><code><a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> surface_id</code></em>, + <em class="parameter"><code><span class="type">SpiceDisplayPrimary</span> *primary</code></em>);</pre> +<p>Retrieve primary display surface <em class="parameter"><code>surface_id</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.2.3.5.11.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceDisplayChannel.html" title="Display Channel"><span class="type">SpiceDisplayChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>surface_id</p></td> +<td class="parameter_description"><p>a surface id</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>primary</p></td> +<td class="parameter_description"><p>a <span class="type">SpiceDisplayPrimary</span></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.3.5.11.2.6"></a><h4>Returns</h4> +<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the primary surface was found and its details +collected in <em class="parameter"><code>primary</code></em> +.</p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="SpiceDisplayChannel.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SpiceDisplayChannel-struct"></a><h3>struct SpiceDisplayChannel</h3> +<pre class="programlisting">struct SpiceDisplayChannel;</pre> +<p>The <a class="link" href="SpiceDisplayChannel.html" title="Display Channel"><span class="type">SpiceDisplayChannel</span></a> struct is opaque and should not be accessed directly.</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceDisplayChannelClass"></a><h3>struct SpiceDisplayChannelClass</h3> +<pre class="programlisting">struct SpiceDisplayChannelClass { + SpiceChannelClass parent_class; + + /* signals */ + void (*display_primary_create)(SpiceChannel *channel, gint format, + gint width, gint height, gint stride, + gint shmid, gpointer data); + void (*display_primary_destroy)(SpiceChannel *channel); + void (*display_invalidate)(SpiceChannel *channel, + gint x, gint y, gint w, gint h); + void (*display_mark)(SpiceChannel *channel, + gboolean mark); +}; +</pre> +<p>Class structure for <a class="link" href="SpiceDisplayChannel.html" title="Display Channel"><span class="type">SpiceDisplayChannel</span></a>.</p> +<div class="refsect3"> +<a name="id-1.2.3.5.12.3.5"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="struct_member_name"><p><a class="link" href="SpiceChannel.html#SpiceChannelClass" title="SpiceChannelClass"><span class="type">SpiceChannelClass</span></a> <em class="structfield"><code><a name="SpiceDisplayChannelClass.parent-class"></a>parent_class</code></em>;</p></td> +<td class="struct_member_description"><p>Parent class.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceDisplayChannelClass.display-primary-create"></a>display_primary_create</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel-display-primary-create" title="The “display-primary-create” signal"><span class="type">“display-primary-create”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceDisplayChannelClass.display-primary-destroy"></a>display_primary_destroy</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel-display-primary-destroy" title="The “display-primary-destroy” signal"><span class="type">“display-primary-destroy”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceDisplayChannelClass.display-invalidate"></a>display_invalidate</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel-display-invalidate" title="The “display-invalidate” signal"><span class="type">“display-invalidate”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceDisplayChannelClass.display-mark"></a>display_mark</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel-display-mark" title="The “display-mark” signal"><span class="type">“display-mark”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="SpiceDisplayChannel.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="SpiceDisplayChannel--height"></a><h3>The <code class="literal">“height”</code> property</h3> +<pre class="programlisting"> “height” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> +<p>The primary surface height.</p> +<p>Flags: Read</p> +<p>Default value: 0</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceDisplayChannel--monitors"></a><h3>The <code class="literal">“monitors”</code> property</h3> +<pre class="programlisting"> “monitors” <a href="/usr/share/gtk-doc/html/glib/glib-Arrays.html#GArray"><span class="type">GArray</span></a> *</pre> +<p>Current monitors configuration.</p> +<p>Flags: Read</p> +<p class="since">Since: 0.13</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceDisplayChannel--monitors-max"></a><h3>The <code class="literal">“monitors-max”</code> property</h3> +<pre class="programlisting"> “monitors-max” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> +<p>The maximum number of monitors the server or guest supports. +May change during client lifetime, for instance guest may +reboot or dynamically adjust this.</p> +<p>Flags: Read</p> +<p>Allowed values: [1,256]</p> +<p>Default value: 1</p> +<p class="since">Since: 0.13</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceDisplayChannel--width"></a><h3>The <code class="literal">“width”</code> property</h3> +<pre class="programlisting"> “width” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> +<p>The primary surface width.</p> +<p>Flags: Read</p> +<p>Default value: 0</p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceDisplayChannel.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="SpiceDisplayChannel-display-invalidate"></a><h3>The <code class="literal">“display-invalidate”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceDisplayChannel.html" title="Display Channel"><span class="type">SpiceDisplayChannel</span></a> *display, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel-display-invalidate" title="The “display-invalidate” signal"><span class="type">“display-invalidate”</span></a> signal is emitted +when the rectangular region x/y/w/h of the primary buffer is +updated.</p> +<div class="refsect3"> +<a name="id-1.2.3.5.14.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 <a class="link" href="SpiceDisplayChannel.html" title="Display Channel"><span class="type">SpiceDisplayChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>x</p></td> +<td class="parameter_description"><p>x position</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>y</p></td> +<td class="parameter_description"><p>y position</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>width</p></td> +<td class="parameter_description"><p>width</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>height</p></td> +<td class="parameter_description"><p>height</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceDisplayChannel-display-mark"></a><h3>The <code class="literal">“display-mark”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceDisplayChannel.html" title="Display Channel"><span class="type">SpiceDisplayChannel</span></a> *display, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> mark, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel-display-mark" title="The “display-mark” signal"><span class="type">“display-mark”</span></a> signal is emitted when +the <code class="literal">RED_DISPLAY_MARK</code> command is received, and the display +should be exposed.</p> +<div class="refsect3"> +<a name="id-1.2.3.5.14.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 <a class="link" href="SpiceDisplayChannel.html" title="Display Channel"><span class="type">SpiceDisplayChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>mark</p></td> +<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> when the display mark has been received</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceDisplayChannel-display-primary-create"></a><h3>The <code class="literal">“display-primary-create”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceDisplayChannel.html" title="Display Channel"><span class="type">SpiceDisplayChannel</span></a> *display, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> format, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> stride, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> shmid, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> imgdata, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel-display-primary-create" title="The “display-primary-create” signal"><span class="type">“display-primary-create”</span></a> signal +provides main display buffer data.</p> +<div class="refsect3"> +<a name="id-1.2.3.5.14.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 <a class="link" href="SpiceDisplayChannel.html" title="Display Channel"><span class="type">SpiceDisplayChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>format</p></td> +<td class="parameter_description"><p><code class="literal">SPICE_SURFACE_FMT_32_xRGB</code> or <code class="literal">SPICE_SURFACE_FMT_16_555</code>;</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>width</p></td> +<td class="parameter_description"><p>width resolution</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>height</p></td> +<td class="parameter_description"><p>height resolution</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>stride</p></td> +<td class="parameter_description"><p>the buffer stride ("width" padding)</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>shmid</p></td> +<td class="parameter_description"><p>identifier of the shared memory segment associated with +the <em class="parameter"><code>imgdata</code></em> +, or -1 if not shm</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>imgdata</p></td> +<td class="parameter_description"><p>pointer to surface buffer</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceDisplayChannel-display-primary-destroy"></a><h3>The <code class="literal">“display-primary-destroy”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceDisplayChannel.html" title="Display Channel"><span class="type">SpiceDisplayChannel</span></a> *display, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel-display-primary-destroy" title="The “display-primary-destroy” signal"><span class="type">“display-primary-destroy”</span></a> signal is +emitted when the primary surface is freed and should not be +accessed anymore.</p> +<div class="refsect3"> +<a name="id-1.2.3.5.14.5.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 <a class="link" href="SpiceDisplayChannel.html" title="Display Channel"><span class="type">SpiceDisplayChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceDisplayChannel.see-also"></a><h2>See Also</h2> +<p><a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a>, and the GTK widget <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a></p> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/SpiceFileTransferTask.html b/content-extra/api/spice-gtk/SpiceFileTransferTask.html new file mode 100644 index 0000000..8175398 --- /dev/null +++ b/content-extra/api/spice-gtk/SpiceFileTransferTask.html @@ -0,0 +1,379 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>File Transfer Task: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="application-support.html" title="Application Support, from spice-client-glib"> +<link rel="prev" href="spice-gtk-SpiceURI.html" title="SpiceURI"> +<link rel="next" href="object-tree.html" title="Object Hierarchy"> +<meta name="generator" content="GTK-Doc V1.24 (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="#SpiceFileTransferTask.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#SpiceFileTransferTask.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#SpiceFileTransferTask.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> + <a href="#SpiceFileTransferTask.signals" class="shortcut">Signals</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="application-support.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="spice-gtk-SpiceURI.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="SpiceFileTransferTask"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="SpiceFileTransferTask.top_of_page"></a>File Transfer Task</span></h2> +<p>File Transfer Task — Monitoring file transfers</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="SpiceFileTransferTask.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="SpiceFileTransferTask.functions"></a><h2>Functions</h2> +<div class="informaltable"><table 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">double</span> +</td> +<td class="function_name"> +<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> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="SpiceFileTransferTask.html#spice-file-transfer-task-get-filename" title="spice_file_transfer_task_get_filename ()">spice_file_transfer_task_get_filename</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="SpiceFileTransferTask.html#spice-file-transfer-task-cancel" title="spice_file_transfer_task_cancel ()">spice_file_transfer_task_cancel</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceFileTransferTask.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"> +<a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceFileTransferTask.html#SpiceFileTransferTask--cancellable" title="The “cancellable” property">cancellable</a></td> +<td class="property_flags">Read / Write / Construct Only</td> +</tr> +<tr> +<td class="property_type"> +<a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceFileTransferTask.html#SpiceFileTransferTask--channel" title="The “channel” property">channel</a></td> +<td class="property_flags">Read / Write / Construct Only</td> +</tr> +<tr> +<td class="property_type"> +<a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceFileTransferTask.html#SpiceFileTransferTask--file" title="The “file” property">file</a></td> +<td class="property_flags">Read / Write / Construct Only</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> +<td class="property_name"><a class="link" href="SpiceFileTransferTask.html#SpiceFileTransferTask--id" title="The “id” property">id</a></td> +<td class="property_flags">Read / Write / Construct Only</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td> +<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> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceFileTransferTask.signals"></a><h2>Signals</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="signals_return"> +<col width="300px" class="signals_name"> +<col width="200px" class="signals_flags"> +</colgroup> +<tbody><tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceFileTransferTask.html#SpiceFileTransferTask-finished" title="The “finished” signal">finished</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceFileTransferTask.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceFileTransferTask.html#SpiceFileTransferTask-struct" title="struct SpiceFileTransferTask">SpiceFileTransferTask</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceFileTransferTask.html#SpiceFileTransferTaskClass" title="struct SpiceFileTransferTaskClass">SpiceFileTransferTaskClass</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceFileTransferTask.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">╰──</span> SpiceFileTransferTask +</pre> +</div> +<div class="refsect1"> +<a name="SpiceFileTransferTask.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-client.h> +</pre> +</div> +<div class="refsect1"> +<a name="SpiceFileTransferTask.description"></a><h2>Description</h2> +<p>SpiceFileTransferTask is an object that represents a particular file +transfer between the client and the guest. The properties and signals of the +object can be used to monitor the status and result of the transfer. The +Main Channel's <a class="link" href="SpiceMainChannel.html#SpiceMainChannel-new-file-transfer" title="The “new-file-transfer” signal"><span class="type">“new-file-transfer”</span></a> signal will be emitted +whenever a new file transfer task is initiated.</p> +</div> +<div class="refsect1"> +<a name="SpiceFileTransferTask.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="spice-file-transfer-task-get-progress"></a><h3>spice_file_transfer_task_get_progress ()</h3> +<pre class="programlisting"><span class="returnvalue">double</span> +spice_file_transfer_task_get_progress (<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>Convenience function for retrieving the current progress of this file +transfer task.</p> +<div class="refsect3"> +<a name="id-1.2.5.8.11.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="id-1.2.5.8.11.2.6"></a><h4>Returns</h4> +<p> A percentage value between 0 and 100</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-file-transfer-task-get-filename"></a><h3>spice_file_transfer_task_get_filename ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * +spice_file_transfer_task_get_filename (<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 name of the file being transferred in this task</p> +<div class="refsect3"> +<a name="id-1.2.5.8.11.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="id-1.2.5.8.11.3.6"></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> +</div> +</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> +<p>Cancels the file transfer task. Note that depending on how the file transfer +was initiated, multiple file transfer tasks may share a single +<span class="type">“cancellable”</span> object, so canceling one task may result +in the cancellation of other tasks.</p> +<div class="refsect3"> +<a name="id-1.2.5.8.11.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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> +</div> +<div class="refsect1"> +<a name="SpiceFileTransferTask.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SpiceFileTransferTask-struct"></a><h3>struct SpiceFileTransferTask</h3> +<pre class="programlisting">struct SpiceFileTransferTask;</pre> +<p>The <span class="type">FileTransferTask</span> struct is opaque and should not be accessed directly.</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceFileTransferTaskClass"></a><h3>struct SpiceFileTransferTaskClass</h3> +<pre class="programlisting">struct SpiceFileTransferTaskClass { + GObjectClass parent_class; +}; +</pre> +<p>Class structure for <a class="link" href="SpiceFileTransferTask.html" title="File Transfer Task"><span class="type">SpiceFileTransferTask</span></a>.</p> +<div class="refsect3"> +<a name="id-1.2.5.8.12.3.5"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody><tr> +<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="SpiceFileTransferTaskClass.parent-class"></a>parent_class</code></em>;</p></td> +<td class="struct_member_description"><p>Parent class.</p></td> +<td class="struct_member_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="SpiceFileTransferTask.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="SpiceFileTransferTask--cancellable"></a><h3>The <code class="literal">“cancellable”</code> property</h3> +<pre class="programlisting"> “cancellable” <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *</pre> +<p>A cancellable object used to cancel the file transfer</p> +<p>Flags: Read / Write / Construct Only</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceFileTransferTask--channel"></a><h3>The <code class="literal">“channel”</code> property</h3> +<pre class="programlisting"> “channel” <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *</pre> +<p>The main channel that owns the file transfer task</p> +<p>Flags: Read / Write / Construct Only</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceFileTransferTask--file"></a><h3>The <code class="literal">“file”</code> property</h3> +<pre class="programlisting"> “file” <a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> *</pre> +<p>The file that is being transferred in this file transfer task</p> +<p>Flags: Read / Write / Construct Only</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceFileTransferTask--id"></a><h3>The <code class="literal">“id”</code> property</h3> +<pre class="programlisting"> “id” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> +<p>The ID of the file transfer task</p> +<p>Flags: Read / Write / Construct Only</p> +<p>Default value: 0</p> +</div> +<hr> +<div class="refsect2"> +<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/glib/glib-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 +this property to be updated whenever the file transfer progress changes.</p> +<p>Flags: Read</p> +<p>Allowed values: [0,100]</p> +<p>Default value: 0</p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceFileTransferTask.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="SpiceFileTransferTask-finished"></a><h3>The <code class="literal">“finished”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceFileTransferTask.html" title="File Transfer Task"><span class="type">SpiceFileTransferTask</span></a> *task, + <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpiceFileTransferTask.html#SpiceFileTransferTask-finished" title="The “finished” signal"><span class="type">“finished”</span></a> signal is emitted when the file +transfer has completed transferring to the guest.</p> +<div class="refsect3"> +<a name="id-1.2.5.8.14.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>task</p></td> +<td class="parameter_description"><p>the file transfer task that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p> the error state of the transfer. Will be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> +if the file transfer was successful. </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> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceFileTransferTask.see-also"></a><h2>See Also</h2> +<p><a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a></p> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/SpiceGtkSession.html b/content-extra/api/spice-gtk/SpiceGtkSession.html new file mode 100644 index 0000000..cebf0fd --- /dev/null +++ b/content-extra/api/spice-gtk/SpiceGtkSession.html @@ -0,0 +1,321 @@ +<!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.78.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="SpiceDisplay.html" title="Spice Display"> +<meta name="generator" content="GTK-Doc V1.24 (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="#SpiceGtkSession.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#SpiceGtkSession.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#SpiceGtkSession.properties" class="shortcut">Properties</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="SpiceDisplay.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="SpiceGtkSession"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="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="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="SpiceGtkSession.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<a class="link" href="SpiceGtkSession.html" title="Spice GTK Session"><span class="returnvalue">SpiceGtkSession</span></a> * +</td> +<td class="function_name"> +<a class="link" href="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="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="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="SpiceGtkSession.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceGtkSession.html#SpiceGtkSession--auto-clipboard" title="The “auto-clipboard” property">auto-clipboard</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceGtkSession.html#SpiceGtkSession--auto-usbredir" title="The “auto-usbredir” property">auto-usbredir</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceGtkSession.html#SpiceGtkSession--pointer-grabbed" title="The “pointer-grabbed” property">pointer-grabbed</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="SpiceGtkSession.html#SpiceGtkSession--session" title="The “session” property">session</a></td> +<td class="property_flags">Read / Write / Construct Only</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceGtkSession.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceGtkSession.html#SpiceGtkSession-struct" title="struct SpiceGtkSession">SpiceGtkSession</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceGtkSession.html#SpiceGtkSessionClass" title="struct SpiceGtkSessionClass">SpiceGtkSessionClass</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceGtkSession.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">╰──</span> SpiceGtkSession +</pre> +</div> +<div class="refsect1"> +<a name="SpiceGtkSession.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-client-gtk.h> +</pre> +</div> +<div class="refsect1"> +<a name="SpiceGtkSession.description"></a><h2>Description</h2> +<p>The <a class="link" href="SpiceGtkSession.html" title="Spice GTK Session"><span class="type">SpiceGtkSession</span></a> 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 <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a> (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 <a class="link" href="SpiceGtkSession.html" title="Spice GTK Session"><span class="type">SpiceGtkSession</span></a> 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="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 +<a class="link" href="SpiceGtkSession.html#SpiceGtkSession--auto-clipboard" title="The “auto-clipboard” property"><span class="type">“auto-clipboard”</span></a> is set to <a href="/usr/share/gtk-doc/html/glib/glib-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="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="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="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"><a class="link" href="SpiceGtkSession.html" title="Spice GTK Session"><span class="returnvalue">SpiceGtkSession</span></a> * +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 <a class="link" href="SpiceGtkSession.html" title="Spice GTK Session"><span class="type">SpiceGtkSession</span></a> associated with the passed in <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a>. +A new <a class="link" href="SpiceGtkSession.html" title="Spice GTK Session"><span class="type">SpiceGtkSession</span></a> 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="id-1.2.4.2.10.2.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 <a class="link" href="SpiceGtkSession.html" title="Spice GTK Session"><span class="type">SpiceGtkSession</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.4.2.10.2.7"></a><h4>Returns</h4> +<p> a weak reference to the <a class="link" href="SpiceGtkSession.html" title="Spice GTK Session"><span class="type">SpiceGtkSession</span></a> 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><a class="link" href="SpiceGtkSession.html" title="Spice GTK Session"><span class="type">SpiceGtkSession</span></a> *self</code></em>);</pre> +<p>Copy client-side clipboard to guest clipboard.</p> +<p>Since 0.8</p> +<div class="refsect3"> +<a name="id-1.2.4.2.10.3.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 class="link" href="SpiceGtkSession.html" title="Spice GTK Session"><span class="type">SpiceGtkSession</span></a></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><a class="link" href="SpiceGtkSession.html" title="Spice GTK Session"><span class="type">SpiceGtkSession</span></a> *self</code></em>);</pre> +<p>Copy guest clipboard to client-side clipboard.</p> +<p>Since 0.8</p> +<div class="refsect3"> +<a name="id-1.2.4.2.10.4.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 class="link" href="SpiceGtkSession.html" title="Spice GTK Session"><span class="type">SpiceGtkSession</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="SpiceGtkSession.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SpiceGtkSession-struct"></a><h3>struct SpiceGtkSession</h3> +<pre class="programlisting">struct SpiceGtkSession;</pre> +<p>The <a class="link" href="SpiceGtkSession.html" title="Spice GTK Session"><span class="type">SpiceGtkSession</span></a> struct is opaque and should not be accessed directly.</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceGtkSessionClass"></a><h3>struct SpiceGtkSessionClass</h3> +<pre class="programlisting">struct SpiceGtkSessionClass { + GObjectClass parent_class; + + /* signals */ +}; +</pre> +<p>Class structure for <a class="link" href="SpiceGtkSession.html" title="Spice GTK Session"><span class="type">SpiceGtkSession</span></a>.</p> +<div class="refsect3"> +<a name="id-1.2.4.2.11.3.5"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody><tr> +<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="SpiceGtkSessionClass.parent-class"></a>parent_class</code></em>;</p></td> +<td class="struct_member_description"><p>Parent class.</p></td> +<td class="struct_member_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="SpiceGtkSession.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="SpiceGtkSession--auto-clipboard"></a><h3>The <code class="literal">“auto-clipboard”</code> property</h3> +<pre class="programlisting"> “auto-clipboard” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>When this is true the clipboard gets automatically shared between host +and guest.</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: TRUE</p> +<p class="since">Since: 0.8</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceGtkSession--auto-usbredir"></a><h3>The <code class="literal">“auto-usbredir”</code> property</h3> +<pre class="programlisting"> “auto-usbredir” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Automatically redirect newly plugged in USB devices. Note the auto +redirection only happens when a <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a> associated with the +session had keyboard focus.</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: FALSE</p> +<p class="since">Since: 0.8</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceGtkSession--pointer-grabbed"></a><h3>The <code class="literal">“pointer-grabbed”</code> property</h3> +<pre class="programlisting"> “pointer-grabbed” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the pointer is currently grabbed by this session.</p> +<p>Flags: Read</p> +<p>Default value: FALSE</p> +<p class="since">Since: 0.27</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceGtkSession--session"></a><h3>The <code class="literal">“session”</code> property</h3> +<pre class="programlisting"> “session” <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> *</pre> +<p><a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> this <a class="link" href="SpiceGtkSession.html" title="Spice GTK Session"><span class="type">SpiceGtkSession</span></a> is associated with</p> +<p>Flags: Read / Write / Construct Only</p> +<p class="since">Since: 0.8</p> +</div> +</div> +<div class="refsect1"> +<a name="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 <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a></p> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/SpiceInputsChannel.html b/content-extra/api/spice-gtk/SpiceInputsChannel.html new file mode 100644 index 0000000..baf6c83 --- /dev/null +++ b/content-extra/api/spice-gtk/SpiceInputsChannel.html @@ -0,0 +1,621 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Inputs Channel: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="ch02.html" title="Session and Channels Objects, from spice-client-glib"> +<link rel="prev" href="SpiceDisplayChannel.html" title="Display Channel"> +<link rel="next" href="SpiceMainChannel.html" title="Main Channel"> +<meta name="generator" content="GTK-Doc V1.24 (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="#SpiceInputsChannel.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#SpiceInputsChannel.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#SpiceInputsChannel.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> + <a href="#SpiceInputsChannel.signals" class="shortcut">Signals</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="SpiceDisplayChannel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="SpiceMainChannel.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="SpiceInputsChannel"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="SpiceInputsChannel.top_of_page"></a>Inputs Channel</span></h2> +<p>Inputs Channel — control the server mouse and keyboard</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="SpiceInputsChannel.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="SpiceInputsChannel.functions"></a><h2>Functions</h2> +<div class="informaltable"><table 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">void</span> +</td> +<td class="function_name"> +<a class="link" href="SpiceInputsChannel.html#spice-inputs-motion" title="spice_inputs_motion ()">spice_inputs_motion</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="SpiceInputsChannel.html#spice-inputs-position" title="spice_inputs_position ()">spice_inputs_position</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="SpiceInputsChannel.html#spice-inputs-button-press" title="spice_inputs_button_press ()">spice_inputs_button_press</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="SpiceInputsChannel.html#spice-inputs-button-release" title="spice_inputs_button_release ()">spice_inputs_button_release</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="SpiceInputsChannel.html#spice-inputs-key-press" title="spice_inputs_key_press ()">spice_inputs_key_press</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="SpiceInputsChannel.html#spice-inputs-key-press-and-release" title="spice_inputs_key_press_and_release ()">spice_inputs_key_press_and_release</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="SpiceInputsChannel.html#spice-inputs-key-release" title="spice_inputs_key_release ()">spice_inputs_key_release</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="SpiceInputsChannel.html#spice-inputs-set-key-locks" title="spice_inputs_set_key_locks ()">spice_inputs_set_key_locks</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceInputsChannel.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody><tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> +<td class="property_name"><a class="link" href="SpiceInputsChannel.html#SpiceInputsChannel--key-modifiers" title="The “key-modifiers” property">key-modifiers</a></td> +<td class="property_flags">Read</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceInputsChannel.signals"></a><h2>Signals</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="signals_return"> +<col width="300px" class="signals_name"> +<col width="200px" class="signals_flags"> +</colgroup> +<tbody><tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceInputsChannel.html#SpiceInputsChannel-inputs-modifiers" title="The “inputs-modifiers” signal">inputs-modifiers</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceInputsChannel.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceInputsChannel.html#SpiceInputsChannel-struct" title="struct SpiceInputsChannel">SpiceInputsChannel</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceInputsChannel.html#SpiceInputsChannelClass" title="struct SpiceInputsChannelClass">SpiceInputsChannelClass</a></td> +</tr> +<tr> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="SpiceInputsChannel.html#SpiceInputsLock" title="enum SpiceInputsLock">SpiceInputsLock</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceInputsChannel.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GFlags</a> + <span class="lineart">╰──</span> SpiceInputsLock + <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">╰──</span> <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> + <span class="lineart">╰──</span> SpiceInputsChannel +</pre> +</div> +<div class="refsect1"> +<a name="SpiceInputsChannel.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-client.h> +</pre> +</div> +<div class="refsect1"> +<a name="SpiceInputsChannel.description"></a><h2>Description</h2> +<p>Spice supports sending keyboard key events and keyboard leds +synchronization. The key events are sent using +<a class="link" href="SpiceInputsChannel.html#spice-inputs-key-press" title="spice_inputs_key_press ()"><code class="function">spice_inputs_key_press()</code></a> and <a class="link" href="SpiceInputsChannel.html#spice-inputs-key-release" title="spice_inputs_key_release ()"><code class="function">spice_inputs_key_release()</code></a> using +a modified variant of PC XT scancodes.</p> +<p>Guest keyboard leds state can be manipulated with +<a class="link" href="SpiceInputsChannel.html#spice-inputs-set-key-locks" title="spice_inputs_set_key_locks ()"><code class="function">spice_inputs_set_key_locks()</code></a>. When key lock change, a notification +is emitted with <a class="link" href="SpiceInputsChannel.html#SpiceInputsChannel-inputs-modifiers" title="The “inputs-modifiers” signal"><span class="type">“inputs-modifiers”</span></a> signal.</p> +</div> +<div class="refsect1"> +<a name="SpiceInputsChannel.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="spice-inputs-motion"></a><h3>spice_inputs_motion ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_inputs_motion (<em class="parameter"><code><a class="link" href="SpiceInputsChannel.html" title="Inputs Channel"><span class="type">SpiceInputsChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> dx</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> dy</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> button_state</code></em>);</pre> +<p>Change mouse position (used in SPICE_MOUSE_MODE_CLIENT).</p> +<div class="refsect3"> +<a name="id-1.2.3.6.11.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel"><span class="type">SpiceInputsChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>dx</p></td> +<td class="parameter_description"><p>delta X mouse coordinates</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>dy</p></td> +<td class="parameter_description"><p>delta Y mouse coordinates</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>button_state</p></td> +<td class="parameter_description"><p>SPICE_MOUSE_BUTTON_MASK flags</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-inputs-position"></a><h3>spice_inputs_position ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_inputs_position (<em class="parameter"><code><a class="link" href="SpiceInputsChannel.html" title="Inputs Channel"><span class="type">SpiceInputsChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> display</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> button_state</code></em>);</pre> +<p>Change mouse position (used in SPICE_MOUSE_MODE_CLIENT).</p> +<div class="refsect3"> +<a name="id-1.2.3.6.11.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel"><span class="type">SpiceInputsChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>x</p></td> +<td class="parameter_description"><p>X mouse coordinates</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>y</p></td> +<td class="parameter_description"><p>Y mouse coordinates</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>display</p></td> +<td class="parameter_description"><p>display channel id</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>button_state</p></td> +<td class="parameter_description"><p>SPICE_MOUSE_BUTTON_MASK flags</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-inputs-button-press"></a><h3>spice_inputs_button_press ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_inputs_button_press (<em class="parameter"><code><a class="link" href="SpiceInputsChannel.html" title="Inputs Channel"><span class="type">SpiceInputsChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> button</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> button_state</code></em>);</pre> +<p>Press a mouse button.</p> +<div class="refsect3"> +<a name="id-1.2.3.6.11.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel"><span class="type">SpiceInputsChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>button</p></td> +<td class="parameter_description"><p>a SPICE_MOUSE_BUTTON</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>button_state</p></td> +<td class="parameter_description"><p>SPICE_MOUSE_BUTTON_MASK flags</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-inputs-button-release"></a><h3>spice_inputs_button_release ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_inputs_button_release (<em class="parameter"><code><a class="link" href="SpiceInputsChannel.html" title="Inputs Channel"><span class="type">SpiceInputsChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> button</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> button_state</code></em>);</pre> +<p>Release a button.</p> +<div class="refsect3"> +<a name="id-1.2.3.6.11.5.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel"><span class="type">SpiceInputsChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>button</p></td> +<td class="parameter_description"><p>a SPICE_MOUSE_BUTTON</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>button_state</p></td> +<td class="parameter_description"><p>SPICE_MOUSE_BUTTON_MASK flags</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-inputs-key-press"></a><h3>spice_inputs_key_press ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_inputs_key_press (<em class="parameter"><code><a class="link" href="SpiceInputsChannel.html" title="Inputs Channel"><span class="type">SpiceInputsChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> scancode</code></em>);</pre> +<p>Press a key.</p> +<div class="refsect3"> +<a name="id-1.2.3.6.11.6.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel"><span class="type">SpiceInputsChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>scancode</p></td> +<td class="parameter_description"><p>a PC XT (set 1) key scancode. For scancodes with an <code class="literal">0xe0</code> +prefix, drop the prefix and OR the scancode with <code class="literal">0x100</code>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-inputs-key-press-and-release"></a><h3>spice_inputs_key_press_and_release ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_inputs_key_press_and_release (<em class="parameter"><code><a class="link" href="SpiceInputsChannel.html" title="Inputs Channel"><span class="type">SpiceInputsChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> scancode</code></em>);</pre> +<p>Press and release a key event atomically (in the same message).</p> +<div class="refsect3"> +<a name="id-1.2.3.6.11.7.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel"><span class="type">SpiceInputsChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>scancode</p></td> +<td class="parameter_description"><p>a PC XT (set 1) key scancode. For scancodes with an <code class="literal">0xe0</code> +prefix, drop the prefix and OR the scancode with <code class="literal">0x100</code>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: 0.13</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-inputs-key-release"></a><h3>spice_inputs_key_release ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_inputs_key_release (<em class="parameter"><code><a class="link" href="SpiceInputsChannel.html" title="Inputs Channel"><span class="type">SpiceInputsChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> scancode</code></em>);</pre> +<p>Release a key.</p> +<div class="refsect3"> +<a name="id-1.2.3.6.11.8.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel"><span class="type">SpiceInputsChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>scancode</p></td> +<td class="parameter_description"><p>a PC XT (set 1) key scancode. For scancodes with an <code class="literal">0xe0</code> +prefix, drop the prefix and OR the scancode with <code class="literal">0x100</code>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-inputs-set-key-locks"></a><h3>spice_inputs_set_key_locks ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_inputs_set_key_locks (<em class="parameter"><code><a class="link" href="SpiceInputsChannel.html" title="Inputs Channel"><span class="type">SpiceInputsChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> locks</code></em>);</pre> +<p>Set the keyboard locks on the guest (Caps, Num, Scroll..)</p> +<div class="refsect3"> +<a name="id-1.2.3.6.11.9.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel"><span class="type">SpiceInputsChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>locks</p></td> +<td class="parameter_description"><p><a class="link" href="SpiceInputsChannel.html#SpiceInputsLock" title="enum SpiceInputsLock"><span class="type">SpiceInputsLock</span></a> modifiers flags</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="SpiceInputsChannel.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SpiceInputsChannel-struct"></a><h3>struct SpiceInputsChannel</h3> +<pre class="programlisting">struct SpiceInputsChannel;</pre> +<p>The <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel"><span class="type">SpiceInputsChannel</span></a> struct is opaque and should not be accessed directly.</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceInputsChannelClass"></a><h3>struct SpiceInputsChannelClass</h3> +<pre class="programlisting">struct SpiceInputsChannelClass { + SpiceChannelClass parent_class; + + /* signals */ + void (*inputs_modifiers)(SpiceChannel *channel); +}; +</pre> +<p>Class structure for <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel"><span class="type">SpiceInputsChannel</span></a>.</p> +<div class="refsect3"> +<a name="id-1.2.3.6.12.3.5"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="struct_member_name"><p><a class="link" href="SpiceChannel.html#SpiceChannelClass" title="SpiceChannelClass"><span class="type">SpiceChannelClass</span></a> <em class="structfield"><code><a name="SpiceInputsChannelClass.parent-class"></a>parent_class</code></em>;</p></td> +<td class="struct_member_description"><p>Parent class.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceInputsChannelClass.inputs-modifiers"></a>inputs_modifiers</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceInputsChannel.html#SpiceInputsChannel-inputs-modifiers" title="The “inputs-modifiers” signal"><span class="type">“inputs-modifiers”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceInputsLock"></a><h3>enum SpiceInputsLock</h3> +<p>Constants used to synchronize modifiers between a client and a guest.</p> +<div class="refsect3"> +<a name="id-1.2.3.6.12.4.4"></a><h4>Members</h4> +<div class="informaltable"><table 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-INPUTS-SCROLL-LOCK:CAPS"></a>SPICE_INPUTS_SCROLL_LOCK</p></td> +<td class="enum_member_description"> +<p>Scroll Lock</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="SPICE-INPUTS-NUM-LOCK:CAPS"></a>SPICE_INPUTS_NUM_LOCK</p></td> +<td class="enum_member_description"> +<p>Num Lock</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="SPICE-INPUTS-CAPS-LOCK:CAPS"></a>SPICE_INPUTS_CAPS_LOCK</p></td> +<td class="enum_member_description"> +<p>Caps Lock</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="SpiceInputsChannel.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="SpiceInputsChannel--key-modifiers"></a><h3>The <code class="literal">“key-modifiers”</code> property</h3> +<pre class="programlisting"> “key-modifiers” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> +<p>Guest keyboard lock/led state.</p> +<p>Flags: Read</p> +<p>Allowed values: >= 0</p> +<p>Default value: 0</p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceInputsChannel.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="SpiceInputsChannel-inputs-modifiers"></a><h3>The <code class="literal">“inputs-modifiers”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceInputsChannel.html" title="Inputs Channel"><span class="type">SpiceInputsChannel</span></a> *display, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpiceInputsChannel.html#SpiceInputsChannel-inputs-modifiers" title="The “inputs-modifiers” signal"><span class="type">“inputs-modifiers”</span></a> signal is emitted when +the guest keyboard locks are changed. You can read the current +state from <a class="link" href="SpiceInputsChannel.html#SpiceInputsChannel--key-modifiers" title="The “key-modifiers” property"><span class="type">“key-modifiers”</span></a> property.</p> +<div class="refsect3"> +<a name="id-1.2.3.6.14.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel"><span class="type">SpiceInputsChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceInputsChannel.see-also"></a><h2>See Also</h2> +<p><a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a>, and the GTK widget <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a></p> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/SpiceMainChannel.html b/content-extra/api/spice-gtk/SpiceMainChannel.html new file mode 100644 index 0000000..8a2fa1f --- /dev/null +++ b/content-extra/api/spice-gtk/SpiceMainChannel.html @@ -0,0 +1,1764 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Main Channel: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="ch02.html" title="Session and Channels Objects, from spice-client-glib"> +<link rel="prev" href="SpiceInputsChannel.html" title="Inputs Channel"> +<link rel="next" href="SpicePlaybackChannel.html" title="Playback Channel"> +<meta name="generator" content="GTK-Doc V1.24 (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="#SpiceMainChannel.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#SpiceMainChannel.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#SpiceMainChannel.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> + <a href="#SpiceMainChannel.signals" class="shortcut">Signals</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="SpiceInputsChannel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="SpicePlaybackChannel.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="SpiceMainChannel"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="SpiceMainChannel.top_of_page"></a>Main Channel</span></h2> +<p>Main Channel — the main Spice channel</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="SpiceMainChannel.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="SpiceMainChannel.functions"></a><h2>Functions</h2> +<div class="informaltable"><table 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">void</span> +</td> +<td class="function_name"> +<a class="link" href="SpiceMainChannel.html#spice-main-set-display" title="spice_main_set_display ()">spice_main_set_display</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="SpiceMainChannel.html#spice-main-set-display-enabled" title="spice_main_set_display_enabled ()">spice_main_set_display_enabled</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="SpiceMainChannel.html#spice-main-update-display" title="spice_main_update_display ()">spice_main_update_display</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="SpiceMainChannel.html#spice-main-update-display-enabled" title="spice_main_update_display_enabled ()">spice_main_update_display_enabled</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceMainChannel.html#spice-main-send-monitor-config" title="spice_main_send_monitor_config ()">spice_main_send_monitor_config</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceMainChannel.html#spice-main-agent-test-capability" title="spice_main_agent_test_capability ()">spice_main_agent_test_capability</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="SpiceMainChannel.html#spice-main-clipboard-selection-grab" title="spice_main_clipboard_selection_grab ()">spice_main_clipboard_selection_grab</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="SpiceMainChannel.html#spice-main-clipboard-selection-notify" title="spice_main_clipboard_selection_notify ()">spice_main_clipboard_selection_notify</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="SpiceMainChannel.html#spice-main-clipboard-selection-release" title="spice_main_clipboard_selection_release ()">spice_main_clipboard_selection_release</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="SpiceMainChannel.html#spice-main-clipboard-selection-request" title="spice_main_clipboard_selection_request ()">spice_main_clipboard_selection_request</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="SpiceMainChannel.html#spice-main-clipboard-grab" title="spice_main_clipboard_grab ()">spice_main_clipboard_grab</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="SpiceMainChannel.html#spice-main-clipboard-release" title="spice_main_clipboard_release ()">spice_main_clipboard_release</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="SpiceMainChannel.html#spice-main-clipboard-notify" title="spice_main_clipboard_notify ()">spice_main_clipboard_notify</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="SpiceMainChannel.html#spice-main-clipboard-request" title="spice_main_clipboard_request ()">spice_main_clipboard_request</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="SpiceMainChannel.html#spice-main-file-copy-async" title="spice_main_file_copy_async ()">spice_main_file_copy_async</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceMainChannel.html#spice-main-file-copy-finish" title="spice_main_file_copy_finish ()">spice_main_file_copy_finish</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceMainChannel.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> +<td class="property_name"><a class="link" href="SpiceMainChannel.html#SpiceMainChannel--agent-caps-0" title="The “agent-caps-0” property">agent-caps-0</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceMainChannel.html#SpiceMainChannel--agent-connected" title="The “agent-connected” property">agent-connected</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> +<td class="property_name"><a class="link" href="SpiceMainChannel.html#SpiceMainChannel--color-depth" title="The “color-depth” property">color-depth</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceMainChannel.html#SpiceMainChannel--disable-animation" title="The “disable-animation” property">disable-animation</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceMainChannel.html#SpiceMainChannel--disable-display-align" title="The “disable-display-align” property">disable-display-align</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceMainChannel.html#SpiceMainChannel--disable-display-position" title="The “disable-display-position” property">disable-display-position</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceMainChannel.html#SpiceMainChannel--disable-font-smooth" title="The “disable-font-smooth” property">disable-font-smooth</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceMainChannel.html#SpiceMainChannel--disable-wallpaper" title="The “disable-wallpaper” property">disable-wallpaper</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> +<td class="property_name"><a class="link" href="SpiceMainChannel.html#SpiceMainChannel--max-clipboard" title="The “max-clipboard” property">max-clipboard</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> +<td class="property_name"><a class="link" href="SpiceMainChannel.html#SpiceMainChannel--mouse-mode" title="The “mouse-mode” property">mouse-mode</a></td> +<td class="property_flags">Read</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceMainChannel.signals"></a><h2>Signals</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="signals_return"> +<col width="300px" class="signals_name"> +<col width="200px" class="signals_flags"> +</colgroup> +<tbody> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-agent-update" title="The “main-agent-update” signal">main-agent-update</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-clipboard" title="The “main-clipboard” signal">main-clipboard</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td> +</tr> +<tr> +<td class="signal_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a></td> +<td class="signal_name"><a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-grab" title="The “main-clipboard-grab” signal">main-clipboard-grab</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-release" title="The “main-clipboard-release” signal">main-clipboard-release</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td> +</tr> +<tr> +<td class="signal_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a></td> +<td class="signal_name"><a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-request" title="The “main-clipboard-request” signal">main-clipboard-request</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-selection" title="The “main-clipboard-selection” signal">main-clipboard-selection</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td> +</tr> +<tr> +<td class="signal_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a></td> +<td class="signal_name"><a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-selection-grab" title="The “main-clipboard-selection-grab” signal">main-clipboard-selection-grab</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-selection-release" title="The “main-clipboard-selection-release” signal">main-clipboard-selection-release</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td> +</tr> +<tr> +<td class="signal_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a></td> +<td class="signal_name"><a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-selection-request" title="The “main-clipboard-selection-request” signal">main-clipboard-selection-request</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-mouse-update" title="The “main-mouse-update” signal">main-mouse-update</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceMainChannel.html#SpiceMainChannel-migration-started" title="The “migration-started” signal">migration-started</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceMainChannel.html#SpiceMainChannel-new-file-transfer" title="The “new-file-transfer” signal">new-file-transfer</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceMainChannel.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceMainChannel.html#SpiceMainChannel-struct" title="struct SpiceMainChannel">SpiceMainChannel</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceMainChannel.html#SpiceMainChannelClass" title="struct SpiceMainChannelClass">SpiceMainChannelClass</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceMainChannel.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">╰──</span> <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> + <span class="lineart">╰──</span> SpiceMainChannel +</pre> +</div> +<div class="refsect1"> +<a name="SpiceMainChannel.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-client.h> +</pre> +</div> +<div class="refsect1"> +<a name="SpiceMainChannel.description"></a><h2>Description</h2> +<p>The main channel is the Spice session control channel. It handles +communication initialization (channels list), migrations, mouse +modes, multimedia time, and agent communication.</p> +</div> +<div class="refsect1"> +<a name="SpiceMainChannel.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="spice-main-set-display"></a><h3>spice_main_set_display ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_main_set_display (<em class="parameter"><code><a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *channel</code></em>, + <em class="parameter"><code><span class="type">int</span> id</code></em>, + <em class="parameter"><code><span class="type">int</span> x</code></em>, + <em class="parameter"><code><span class="type">int</span> y</code></em>, + <em class="parameter"><code><span class="type">int</span> width</code></em>, + <em class="parameter"><code><span class="type">int</span> height</code></em>);</pre> +<p>Notify the guest of screen resolution change. The notification is +sent 1 second later, if no further changes happen.</p> +<div class="refsect3"> +<a name="id-1.2.3.7.11.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>id</p></td> +<td class="parameter_description"><p>display ID</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>x</p></td> +<td class="parameter_description"><p>x position</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>y</p></td> +<td class="parameter_description"><p>y position</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>width</p></td> +<td class="parameter_description"><p>display width</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>height</p></td> +<td class="parameter_description"><p>display height</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-main-set-display-enabled"></a><h3>spice_main_set_display_enabled ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_main_set_display_enabled (<em class="parameter"><code><a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *channel</code></em>, + <em class="parameter"><code><span class="type">int</span> id</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> enabled</code></em>);</pre> +<p>When sending monitor configuration to agent guest, don't set +display <em class="parameter"><code>id</code></em> +, which the agent translates to disabling the display +id. Note: this will take effect next time the monitor +configuration is sent.</p> +<div class="refsect3"> +<a name="id-1.2.3.7.11.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>id</p></td> +<td class="parameter_description"><p>display ID (if -1: set all displays)</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>enabled</p></td> +<td class="parameter_description"><p>wether display <em class="parameter"><code>id</code></em> +is enabled</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: 0.6</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-main-update-display"></a><h3>spice_main_update_display ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_main_update_display (<em class="parameter"><code><a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *channel</code></em>, + <em class="parameter"><code><span class="type">int</span> id</code></em>, + <em class="parameter"><code><span class="type">int</span> x</code></em>, + <em class="parameter"><code><span class="type">int</span> y</code></em>, + <em class="parameter"><code><span class="type">int</span> width</code></em>, + <em class="parameter"><code><span class="type">int</span> height</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> update</code></em>);</pre> +<p>Update the display <em class="parameter"><code>id</code></em> + resolution.</p> +<p>If <em class="parameter"><code>update</code></em> + is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the remote configuration will be updated too +after 1 second without further changes. You can send when you want +without delay the new configuration to the remote with +<a class="link" href="SpiceMainChannel.html#spice-main-send-monitor-config" title="spice_main_send_monitor_config ()"><code class="function">spice_main_send_monitor_config()</code></a></p> +<div class="refsect3"> +<a name="id-1.2.3.7.11.4.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>id</p></td> +<td class="parameter_description"><p>display ID</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>x</p></td> +<td class="parameter_description"><p>x position</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>y</p></td> +<td class="parameter_description"><p>y position</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>width</p></td> +<td class="parameter_description"><p>display width</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>height</p></td> +<td class="parameter_description"><p>display height</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>update</p></td> +<td class="parameter_description"><p>if <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, update guest resolution after 1sec.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-main-update-display-enabled"></a><h3>spice_main_update_display_enabled ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_main_update_display_enabled (<em class="parameter"><code><a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *channel</code></em>, + <em class="parameter"><code><span class="type">int</span> id</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> enabled</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> update</code></em>);</pre> +<p>When sending monitor configuration to agent guest, if <em class="parameter"><code>enabled</code></em> + is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, +don't set display <em class="parameter"><code>id</code></em> +, which the agent translates to disabling the display +id. If <em class="parameter"><code>enabled</code></em> + is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the monitor will be included in the next monitor +update. Note: this will take effect next time the monitor configuration is +sent.</p> +<p>If <em class="parameter"><code>update</code></em> + is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, no server update will be triggered by this call, but +the value will be saved and used in the next configuration update.</p> +<div class="refsect3"> +<a name="id-1.2.3.7.11.5.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>id</p></td> +<td class="parameter_description"><p>display ID (if -1: set all displays)</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>enabled</p></td> +<td class="parameter_description"><p>wether display <em class="parameter"><code>id</code></em> +is enabled</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>update</p></td> +<td class="parameter_description"><p>if <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, update guest display state after 1sec.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: 0.30</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-main-send-monitor-config"></a><h3>spice_main_send_monitor_config ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +spice_main_send_monitor_config (<em class="parameter"><code><a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *channel</code></em>);</pre> +<p>Send monitors configuration previously set with +<a class="link" href="SpiceMainChannel.html#spice-main-set-display" title="spice_main_set_display ()"><code class="function">spice_main_set_display()</code></a> and <a class="link" href="SpiceMainChannel.html#spice-main-set-display-enabled" title="spice_main_set_display_enabled ()"><code class="function">spice_main_set_display_enabled()</code></a></p> +<div class="refsect3"> +<a name="id-1.2.3.7.11.6.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.3.7.11.6.6"></a><h4>Returns</h4> +<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-main-agent-test-capability"></a><h3>spice_main_agent_test_capability ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +spice_main_agent_test_capability (<em class="parameter"><code><a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> cap</code></em>);</pre> +<p>Test capability of a remote agent.</p> +<div class="refsect3"> +<a name="id-1.2.3.7.11.7.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cap</p></td> +<td class="parameter_description"><p>an agent capability identifier</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.3.7.11.7.6"></a><h4>Returns</h4> +<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>cap</code></em> +(channel kind capability) is available.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-main-clipboard-selection-grab"></a><h3>spice_main_clipboard_selection_grab ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_main_clipboard_selection_grab (<em class="parameter"><code><a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> selection</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> *types</code></em>, + <em class="parameter"><code><span class="type">int</span> ntypes</code></em>);</pre> +<p>Grab the guest clipboard, with <span class="type">VD_AGENT_CLIPBOARD</span> <em class="parameter"><code>types</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.2.3.7.11.8.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>selection</p></td> +<td class="parameter_description"><p>one of the clipboard <span class="type">VD_AGENT_CLIPBOARD_SELECTION_</span>*</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>types</p></td> +<td class="parameter_description"><p>an array of <span class="type">VD_AGENT_CLIPBOARD</span> types available in the clipboard</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>ntypes</p></td> +<td class="parameter_description"><p>the number of <em class="parameter"><code>types</code></em> +</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: 0.6</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-main-clipboard-selection-notify"></a><h3>spice_main_clipboard_selection_notify ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_main_clipboard_selection_notify (<em class="parameter"><code><a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> selection</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> type</code></em>, + <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *data</code></em>, + <em class="parameter"><code><span class="type">size_t</span> size</code></em>);</pre> +<p>Send the clipboard data to the guest.</p> +<div class="refsect3"> +<a name="id-1.2.3.7.11.9.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>selection</p></td> +<td class="parameter_description"><p>one of the clipboard <span class="type">VD_AGENT_CLIPBOARD_SELECTION_</span>*</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>type</p></td> +<td class="parameter_description"><p>a <span class="type">VD_AGENT_CLIPBOARD</span> type</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>clipboard data</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>size</p></td> +<td class="parameter_description"><p>data length in bytes</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: 0.6</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-main-clipboard-selection-release"></a><h3>spice_main_clipboard_selection_release ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_main_clipboard_selection_release + (<em class="parameter"><code><a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> selection</code></em>);</pre> +<p>Release the clipboard (for example, when the client loses the +clipboard grab): Inform the guest no clipboard data is available.</p> +<div class="refsect3"> +<a name="id-1.2.3.7.11.10.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>selection</p></td> +<td class="parameter_description"><p>one of the clipboard <span class="type">VD_AGENT_CLIPBOARD_SELECTION_</span>*</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: 0.6</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-main-clipboard-selection-request"></a><h3>spice_main_clipboard_selection_request ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_main_clipboard_selection_request + (<em class="parameter"><code><a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> selection</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> type</code></em>);</pre> +<p>Request clipboard data of <em class="parameter"><code>type</code></em> + from the guest. The reply is sent +through the <a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-selection" title="The “main-clipboard-selection” signal"><span class="type">“main-clipboard-selection”</span></a> signal.</p> +<div class="refsect3"> +<a name="id-1.2.3.7.11.11.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>selection</p></td> +<td class="parameter_description"><p>one of the clipboard <span class="type">VD_AGENT_CLIPBOARD_SELECTION_</span>*</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>type</p></td> +<td class="parameter_description"><p>a <span class="type">VD_AGENT_CLIPBOARD</span> type</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: 0.6</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-main-clipboard-grab"></a><h3>spice_main_clipboard_grab ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_main_clipboard_grab (<em class="parameter"><code><a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> *types</code></em>, + <em class="parameter"><code><span class="type">int</span> ntypes</code></em>);</pre> +<div class="warning"> +<p><code class="literal">spice_main_clipboard_grab</code> has been deprecated since version 0.6 and should not be used in newly-written code.</p> +<p>use <a class="link" href="SpiceMainChannel.html#spice-main-clipboard-selection-grab" title="spice_main_clipboard_selection_grab ()"><code class="function">spice_main_clipboard_selection_grab()</code></a> instead.</p> +</div> +<p>Grab the guest clipboard, with <span class="type">VD_AGENT_CLIPBOARD</span> <em class="parameter"><code>types</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.2.3.7.11.12.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>types</p></td> +<td class="parameter_description"><p>an array of <span class="type">VD_AGENT_CLIPBOARD</span> types available in the clipboard</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>ntypes</p></td> +<td class="parameter_description"><p>the number of <em class="parameter"><code>types</code></em> +</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-main-clipboard-release"></a><h3>spice_main_clipboard_release ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_main_clipboard_release (<em class="parameter"><code><a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *channel</code></em>);</pre> +<div class="warning"> +<p><code class="literal">spice_main_clipboard_release</code> has been deprecated since version 0.6 and should not be used in newly-written code.</p> +<p>use <a class="link" href="SpiceMainChannel.html#spice-main-clipboard-selection-release" title="spice_main_clipboard_selection_release ()"><code class="function">spice_main_clipboard_selection_release()</code></a> instead.</p> +</div> +<p>Release the clipboard (for example, when the client loses the +clipboard grab): Inform the guest no clipboard data is available.</p> +<div class="refsect3"> +<a name="id-1.2.3.7.11.13.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-main-clipboard-notify"></a><h3>spice_main_clipboard_notify ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_main_clipboard_notify (<em class="parameter"><code><a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> type</code></em>, + <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *data</code></em>, + <em class="parameter"><code><span class="type">size_t</span> size</code></em>);</pre> +<div class="warning"> +<p><code class="literal">spice_main_clipboard_notify</code> has been deprecated since version 0.6 and should not be used in newly-written code.</p> +<p>use <a class="link" href="SpiceMainChannel.html#spice-main-clipboard-selection-notify" title="spice_main_clipboard_selection_notify ()"><code class="function">spice_main_clipboard_selection_notify()</code></a> instead.</p> +</div> +<p>Send the clipboard data to the guest.</p> +<div class="refsect3"> +<a name="id-1.2.3.7.11.14.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>type</p></td> +<td class="parameter_description"><p>a <span class="type">VD_AGENT_CLIPBOARD</span> type</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>clipboard data</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>size</p></td> +<td class="parameter_description"><p>data length in bytes</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-main-clipboard-request"></a><h3>spice_main_clipboard_request ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_main_clipboard_request (<em class="parameter"><code><a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> type</code></em>);</pre> +<div class="warning"> +<p><code class="literal">spice_main_clipboard_request</code> has been deprecated since version 0.6 and should not be used in newly-written code.</p> +<p>use <a class="link" href="SpiceMainChannel.html#spice-main-clipboard-selection-request" title="spice_main_clipboard_selection_request ()"><code class="function">spice_main_clipboard_selection_request()</code></a> instead.</p> +</div> +<p>Request clipboard data of <em class="parameter"><code>type</code></em> + from the guest. The reply is sent +through the <a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-clipboard" title="The “main-clipboard” signal"><span class="type">“main-clipboard”</span></a> signal.</p> +<div class="refsect3"> +<a name="id-1.2.3.7.11.15.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>type</p></td> +<td class="parameter_description"><p>a <span class="type">VD_AGENT_CLIPBOARD</span> type</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-main-file-copy-async"></a><h3>spice_main_file_copy_async ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_main_file_copy_async (<em class="parameter"><code><a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> **sources</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GFile.html#GFileCopyFlags"><span class="type">GFileCopyFlags</span></a> flags</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GFile.html#GFileProgressCallback"><span class="type">GFileProgressCallback</span></a> progress_callback</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> progress_callback_data</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> +<p>Copies the file <em class="parameter"><code>sources</code></em> + to guest</p> +<p>If <em class="parameter"><code>cancellable</code></em> + is not <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the operation can be cancelled by +triggering the cancellable object from another thread. If the operation +was cancelled, the error <a href="/usr/share/gtk-doc/html/gio/gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> will be returned.</p> +<p>If <em class="parameter"><code>progress_callback</code></em> + is not <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the operation can be monitored by +setting this to a <a href="/usr/share/gtk-doc/html/gio/GFile.html#GFileProgressCallback"><span class="type">GFileProgressCallback</span></a> function. <em class="parameter"><code>progress_callback_data</code></em> + +will be passed to this function. It is guaranteed that this callback will +be called after all data has been transferred with the total number of bytes +copied during the operation. Note that before release 0.31, progress_callback +was broken since it only provided status for a single file transfer, but did +not provide a way to determine which file it referred to. In release 0.31, +this behavior was changed so that progress_callback provides the status of +all ongoing file transfers. If you need to monitor the status of individual +files, please connect to the <a class="link" href="SpiceMainChannel.html#SpiceMainChannel-new-file-transfer" title="The “new-file-transfer” signal"><span class="type">“new-file-transfer”</span></a> signal.</p> +<p>When the operation is finished, callback will be called. You can then call +<a class="link" href="SpiceMainChannel.html#spice-main-file-copy-finish" title="spice_main_file_copy_finish ()"><code class="function">spice_main_file_copy_finish()</code></a> to get the result of the operation.</p> +<div class="refsect3"> +<a name="id-1.2.3.7.11.16.8"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>sources</p></td> +<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array of <a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> objects to be transferred</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>flags</p></td> +<td class="parameter_description"><p>set of <a href="/usr/share/gtk-doc/html/gio/GFile.html#GFileCopyFlags"><span class="type">GFileCopyFlags</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> optional <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </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> +<tr> +<td class="parameter_name"><p>progress_callback</p></td> +<td class="parameter_description"><p> function to callback with +progress information, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if progress information is not needed. </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>][<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>progress_callback_data</p></td> +<td class="parameter_description"><p> user data to pass to <em class="parameter"><code>progress_callback</code></em> +. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>callback</p></td> +<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when the request is satisfied</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>the data to pass to callback function</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-main-file-copy-finish"></a><h3>spice_main_file_copy_finish ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +spice_main_file_copy_finish (<em class="parameter"><code><a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Finishes copying the file started with +<a class="link" href="SpiceMainChannel.html#spice-main-file-copy-async" title="spice_main_file_copy_async ()"><code class="function">spice_main_file_copy_async()</code></a>.</p> +<div class="refsect3"> +<a name="id-1.2.3.7.11.17.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>result</p></td> +<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.3.7.11.17.6"></a><h4>Returns</h4> +<p> a <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error.</p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="SpiceMainChannel.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SpiceMainChannel-struct"></a><h3>struct SpiceMainChannel</h3> +<pre class="programlisting">struct SpiceMainChannel;</pre> +<p>The <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> struct is opaque and should not be accessed directly.</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceMainChannelClass"></a><h3>struct SpiceMainChannelClass</h3> +<pre class="programlisting">struct SpiceMainChannelClass { + SpiceChannelClass parent_class; + + /* signals */ + void (*mouse_update)(SpiceChannel *channel); + void (*agent_update)(SpiceChannel *channel); +}; +</pre> +<p>Class structure for <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a>.</p> +<div class="refsect3"> +<a name="id-1.2.3.7.12.3.5"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="struct_member_name"><p><a class="link" href="SpiceChannel.html#SpiceChannelClass" title="SpiceChannelClass"><span class="type">SpiceChannelClass</span></a> <em class="structfield"><code><a name="SpiceMainChannelClass.parent-class"></a>parent_class</code></em>;</p></td> +<td class="struct_member_description"><p>Parent class.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceMainChannelClass.mouse-update"></a>mouse_update</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <span class="type">“mouse-update”</span> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceMainChannelClass.agent-update"></a>agent_update</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <span class="type">“agent-update”</span> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="SpiceMainChannel.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="SpiceMainChannel--agent-caps-0"></a><h3>The <code class="literal">“agent-caps-0”</code> property</h3> +<pre class="programlisting"> “agent-caps-0” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> +<p>Agent capability bits 0 -> 31.</p> +<p>Flags: Read</p> +<p>Allowed values: >= 0</p> +<p>Default value: 0</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceMainChannel--agent-connected"></a><h3>The <code class="literal">“agent-connected”</code> property</h3> +<pre class="programlisting"> “agent-connected” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Whether the agent is connected.</p> +<p>Flags: Read</p> +<p>Default value: FALSE</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceMainChannel--color-depth"></a><h3>The <code class="literal">“color-depth”</code> property</h3> +<pre class="programlisting"> “color-depth” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> +<p>Color depth.</p> +<p>Flags: Read / Write / Construct</p> +<p>Allowed values: <= 32</p> +<p>Default value: 0</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceMainChannel--disable-animation"></a><h3>The <code class="literal">“disable-animation”</code> property</h3> +<pre class="programlisting"> “disable-animation” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Disable guest animations.</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: FALSE</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceMainChannel--disable-display-align"></a><h3>The <code class="literal">“disable-display-align”</code> property</h3> +<pre class="programlisting"> “disable-display-align” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Disable automatic horizontal display position alignment.</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: FALSE</p> +<p class="since">Since: 0.13</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceMainChannel--disable-display-position"></a><h3>The <code class="literal">“disable-display-position”</code> property</h3> +<pre class="programlisting"> “disable-display-position” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Disable using display position when setting monitor config.</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: TRUE</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceMainChannel--disable-font-smooth"></a><h3>The <code class="literal">“disable-font-smooth”</code> property</h3> +<pre class="programlisting"> “disable-font-smooth” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Disable guest font smoothing.</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: FALSE</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceMainChannel--disable-wallpaper"></a><h3>The <code class="literal">“disable-wallpaper”</code> property</h3> +<pre class="programlisting"> “disable-wallpaper” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Disable guest wallpaper.</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: FALSE</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceMainChannel--max-clipboard"></a><h3>The <code class="literal">“max-clipboard”</code> property</h3> +<pre class="programlisting"> “max-clipboard” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> +<p>Maximum size of clipboard operations in bytes (default 100MB, +-1 for unlimited size);</p> +<p>Flags: Read / Write / Construct</p> +<p>Allowed values: >= -1</p> +<p>Default value: 104857600</p> +<p class="since">Since: 0.22</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceMainChannel--mouse-mode"></a><h3>The <code class="literal">“mouse-mode”</code> property</h3> +<pre class="programlisting"> “mouse-mode” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> +<p>Spice protocol specifies two mouse modes, client mode and +server mode. In client mode (<code class="literal">SPICE_MOUSE_MODE_CLIENT</code>), the +affective mouse is the client side mouse: the client sends +mouse position within the display and the server sends mouse +shape messages. In server mode (<code class="literal">SPICE_MOUSE_MODE_SERVER</code>), the +client sends relative mouse movements and the server sends +position and shape commands.</p> +<p>Flags: Read</p> +<p>Allowed values: >= 0</p> +<p>Default value: 0</p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceMainChannel.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="SpiceMainChannel-main-agent-update"></a><h3>The <code class="literal">“main-agent-update”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *main, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Notify when the <a class="link" href="SpiceMainChannel.html" title="Main Channel"><code class="literal">SpiceMainChannel</code></a>:agent-connected or +<a class="link" href="SpiceMainChannel.html" title="Main Channel"><code class="literal">SpiceMainChannel</code></a>:agent-caps-0 property change.</p> +<div class="refsect3"> +<a name="id-1.2.3.7.14.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>main</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceMainChannel-main-clipboard"></a><h3>The <code class="literal">“main-clipboard”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *main, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> type, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> size, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Provides guest clipboard data requested by <a class="link" href="SpiceMainChannel.html#spice-main-clipboard-request" title="spice_main_clipboard_request ()"><code class="function">spice_main_clipboard_request()</code></a>.</p> +<div class="warning"> +<p><code class="literal">SpiceMainChannel::main-clipboard</code> has been deprecated since version 0.6 and should not be used in newly-written code.</p> +<p>use SpiceMainChannel::main-clipboard-selection instead.</p> +</div> +<div class="refsect3"> +<a name="id-1.2.3.7.14.3.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>main</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>type</p></td> +<td class="parameter_description"><p>the VD_AGENT_CLIPBOARD data type</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>clipboard data</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>size</p></td> +<td class="parameter_description"><p>size of <em class="parameter"><code>data</code></em> +in bytes</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceMainChannel-main-clipboard-grab"></a><h3>The <code class="literal">“main-clipboard-grab”</code> signal</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +user_function (<a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *main, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> types, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> ntypes, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Inform when clipboard data is available from the guest, and for +which <em class="parameter"><code>types</code></em> +.</p> +<div class="warning"> +<p><code class="literal">SpiceMainChannel::main-clipboard-grab</code> has been deprecated since version 0.6 and should not be used in newly-written code.</p> +<p>use SpiceMainChannel::main-clipboard-selection-grab instead.</p> +</div> +<div class="refsect3"> +<a name="id-1.2.3.7.14.4.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>main</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>types</p></td> +<td class="parameter_description"><p>the VD_AGENT_CLIPBOARD data types</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>ntypes</p></td> +<td class="parameter_description"><p>the number of <em class="parameter"><code>types</code></em> +</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceMainChannel-main-clipboard-release"></a><h3>The <code class="literal">“main-clipboard-release”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *main, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Inform when the clipboard is released from the guest, when no +clipboard data is available from the guest.</p> +<div class="warning"> +<p><code class="literal">SpiceMainChannel::main-clipboard-release</code> has been deprecated since version 0.6 and should not be used in newly-written code.</p> +<p>use SpiceMainChannel::main-clipboard-selection-release instead.</p> +</div> +<div class="refsect3"> +<a name="id-1.2.3.7.14.5.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>main</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceMainChannel-main-clipboard-request"></a><h3>The <code class="literal">“main-clipboard-request”</code> signal</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +user_function (<a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *main, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> types, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Request clipboard data from the client.</p> +<div class="warning"> +<p><code class="literal">SpiceMainChannel::main-clipboard-request</code> has been deprecated since version 0.6 and should not be used in newly-written code.</p> +<p>use SpiceMainChannel::main-clipboard-selection-request instead.</p> +</div> +<div class="refsect3"> +<a name="id-1.2.3.7.14.6.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>main</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>types</p></td> +<td class="parameter_description"><p>the VD_AGENT_CLIPBOARD request type</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.3.7.14.6.7"></a><h4>Returns</h4> +<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the request is successful</p> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceMainChannel-main-clipboard-selection"></a><h3>The <code class="literal">“main-clipboard-selection”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *main, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> selection, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> type, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> size, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Informs that clipboard selection data are available.</p> +<div class="refsect3"> +<a name="id-1.2.3.7.14.7.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>main</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>selection</p></td> +<td class="parameter_description"><p>a VD_AGENT_CLIPBOARD_SELECTION clipboard</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>type</p></td> +<td class="parameter_description"><p>the VD_AGENT_CLIPBOARD data type</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>clipboard data</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>size</p></td> +<td class="parameter_description"><p>size of <em class="parameter"><code>data</code></em> +in bytes</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p> +<p class="since">Since: 0.6</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceMainChannel-main-clipboard-selection-grab"></a><h3>The <code class="literal">“main-clipboard-selection-grab”</code> signal</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +user_function (<a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *main, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> selection, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> types, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> ntypes, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Inform when clipboard data is available from the guest, and for +which <em class="parameter"><code>types</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.2.3.7.14.8.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>main</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>selection</p></td> +<td class="parameter_description"><p>a VD_AGENT_CLIPBOARD_SELECTION clipboard</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>types</p></td> +<td class="parameter_description"><p>the VD_AGENT_CLIPBOARD data types</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>ntypes</p></td> +<td class="parameter_description"><p>the number of <em class="parameter"><code>types</code></em> +</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p> +<p class="since">Since: 0.6</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceMainChannel-main-clipboard-selection-release"></a><h3>The <code class="literal">“main-clipboard-selection-release”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *main, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> selection, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Inform when the clipboard is released from the guest, when no +clipboard data is available from the guest.</p> +<div class="refsect3"> +<a name="id-1.2.3.7.14.9.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>main</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>selection</p></td> +<td class="parameter_description"><p>a VD_AGENT_CLIPBOARD_SELECTION clipboard</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p> +<p class="since">Since: 0.6</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceMainChannel-main-clipboard-selection-request"></a><h3>The <code class="literal">“main-clipboard-selection-request”</code> signal</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +user_function (<a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *main, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> selection, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> types, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Request clipboard data from the client.</p> +<div class="refsect3"> +<a name="id-1.2.3.7.14.10.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>main</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>selection</p></td> +<td class="parameter_description"><p>a VD_AGENT_CLIPBOARD_SELECTION clipboard</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>types</p></td> +<td class="parameter_description"><p>the VD_AGENT_CLIPBOARD request type</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.3.7.14.10.6"></a><h4>Returns</h4> +<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the request is successful</p> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p> +<p class="since">Since: 0.6</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceMainChannel-main-mouse-update"></a><h3>The <code class="literal">“main-mouse-update”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *main, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Notify when the mouse mode has changed.</p> +<div class="refsect3"> +<a name="id-1.2.3.7.14.11.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>main</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceMainChannel-migration-started"></a><h3>The <code class="literal">“migration-started”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *main, + <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *session, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Inform when migration is starting. Application wishing to make +connections themself can set the <a class="link" href="SpiceSession.html#SpiceSession--client-sockets" title="The “client-sockets” property"><span class="type">“client-sockets”</span></a> +to <em class="parameter"><code>TRUE</code></em> +, then follow <a class="link" href="SpiceSession.html#SpiceSession-channel-new" title="The “channel-new” signal"><span class="type">“channel-new”</span></a> creation, and +use <a class="link" href="SpiceChannel.html#spice-channel-open-fd" title="spice_channel_open_fd ()"><code class="function">spice_channel_open_fd()</code></a> once the socket is created.</p> +<div class="refsect3"> +<a name="id-1.2.3.7.14.12.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>main</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>session</p></td> +<td class="parameter_description"><p>a migration <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>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceMainChannel-new-file-transfer"></a><h3>The <code class="literal">“new-file-transfer”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *main, + <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *task, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>This signal is emitted when a new file transfer task has been initiated +on this channel. Client applications may take a reference on the <em class="parameter"><code>task</code></em> + +object and use it to monitor the status of the file transfer task.</p> +<div class="refsect3"> +<a name="id-1.2.3.7.14.13.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>main</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>task</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceFileTransferTask.html" title="File Transfer Task"><span class="type">SpiceFileTransferTask</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p> +<p class="since">Since: 0.31</p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceMainChannel.see-also"></a><h2>See Also</h2> +<p><a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a>, and the GTK widget <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a></p> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/SpicePlaybackChannel.html b/content-extra/api/spice-gtk/SpicePlaybackChannel.html new file mode 100644 index 0000000..6d76959 --- /dev/null +++ b/content-extra/api/spice-gtk/SpicePlaybackChannel.html @@ -0,0 +1,461 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Playback Channel: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="ch02.html" title="Session and Channels Objects, from spice-client-glib"> +<link rel="prev" href="SpiceMainChannel.html" title="Main Channel"> +<link rel="next" href="SpiceRecordChannel.html" title="Record Channel"> +<meta name="generator" content="GTK-Doc V1.24 (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="#SpicePlaybackChannel.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#SpicePlaybackChannel.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#SpicePlaybackChannel.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> + <a href="#SpicePlaybackChannel.signals" class="shortcut">Signals</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="SpiceMainChannel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="SpiceRecordChannel.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="SpicePlaybackChannel"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="SpicePlaybackChannel.top_of_page"></a>Playback Channel</span></h2> +<p>Playback Channel — audio stream for playback</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="SpicePlaybackChannel.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="SpicePlaybackChannel.functions"></a><h2>Functions</h2> +<div class="informaltable"><table 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">void</span> +</td> +<td class="function_name"> +<a class="link" href="SpicePlaybackChannel.html#spice-playback-channel-set-delay" title="spice_playback_channel_set_delay ()">spice_playback_channel_set_delay</a> <span class="c_punctuation">()</span> +</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpicePlaybackChannel.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> +<td class="property_name"><a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannel--min-latency" title="The “min-latency” property">min-latency</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannel--mute" title="The “mute” property">mute</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> +<td class="property_name"><a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannel--nchannels" title="The “nchannels” property">nchannels</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></td> +<td class="property_name"><a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannel--volume" title="The “volume” property">volume</a></td> +<td class="property_flags">Read / Write</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpicePlaybackChannel.signals"></a><h2>Signals</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="signals_return"> +<col width="300px" class="signals_name"> +<col width="200px" class="signals_flags"> +</colgroup> +<tbody> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannel-playback-data" title="The “playback-data” signal">playback-data</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannel-playback-get-delay" title="The “playback-get-delay” signal">playback-get-delay</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannel-playback-start" title="The “playback-start” signal">playback-start</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannel-playback-stop" title="The “playback-stop” signal">playback-stop</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpicePlaybackChannel.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannel-struct" title="struct SpicePlaybackChannel">SpicePlaybackChannel</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannelClass" title="struct SpicePlaybackChannelClass">SpicePlaybackChannelClass</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpicePlaybackChannel.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">╰──</span> <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> + <span class="lineart">╰──</span> SpicePlaybackChannel +</pre> +</div> +<div class="refsect1"> +<a name="SpicePlaybackChannel.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-client.h> +</pre> +</div> +<div class="refsect1"> +<a name="SpicePlaybackChannel.description"></a><h2>Description</h2> +<p><a class="link" href="SpicePlaybackChannel.html" title="Playback Channel"><span class="type">SpicePlaybackChannel</span></a> class handles an audio playback stream. The +audio data is received via <a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannel-playback-data" title="The “playback-data” signal"><span class="type">“playback-data”</span></a> +signal, and is controlled by the guest with +<a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannel-playback-stop" title="The “playback-stop” signal"><span class="type">“playback-stop”</span></a> and +<a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannel-playback-start" title="The “playback-start” signal"><span class="type">“playback-start”</span></a> signal events.</p> +<p>Note: You may be interested to let the <a class="link" href="SpiceAudio.html" title="Spice Audio"><span class="type">SpiceAudio</span></a> class play and +record audio channels for your application.</p> +</div> +<div class="refsect1"> +<a name="SpicePlaybackChannel.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="spice-playback-channel-set-delay"></a><h3>spice_playback_channel_set_delay ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_playback_channel_set_delay (<em class="parameter"><code><a class="link" href="SpicePlaybackChannel.html" title="Playback Channel"><span class="type">SpicePlaybackChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> delay_ms</code></em>);</pre> +<p>Adjust the multimedia time according to the delay.</p> +<div class="refsect3"> +<a name="id-1.2.3.8.11.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpicePlaybackChannel.html" title="Playback Channel"><span class="type">SpicePlaybackChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>delay_ms</p></td> +<td class="parameter_description"><p>the delay in ms</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="SpicePlaybackChannel.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SpicePlaybackChannel-struct"></a><h3>struct SpicePlaybackChannel</h3> +<pre class="programlisting">struct SpicePlaybackChannel;</pre> +<p>The <a class="link" href="SpicePlaybackChannel.html" title="Playback Channel"><span class="type">SpicePlaybackChannel</span></a> struct is opaque and should not be accessed directly.</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpicePlaybackChannelClass"></a><h3>struct SpicePlaybackChannelClass</h3> +<pre class="programlisting">struct SpicePlaybackChannelClass { + SpiceChannelClass parent_class; + + /* signals */ + void (*playback_start)(SpicePlaybackChannel *channel, + gint format, gint channels, gint freq); + void (*playback_data)(SpicePlaybackChannel *channel, gpointer *data, gint size); + void (*playback_stop)(SpicePlaybackChannel *channel); +}; +</pre> +<p>Class structure for <a class="link" href="SpicePlaybackChannel.html" title="Playback Channel"><span class="type">SpicePlaybackChannel</span></a>.</p> +<div class="refsect3"> +<a name="id-1.2.3.8.12.3.5"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="struct_member_name"><p><a class="link" href="SpiceChannel.html#SpiceChannelClass" title="SpiceChannelClass"><span class="type">SpiceChannelClass</span></a> <em class="structfield"><code><a name="SpicePlaybackChannelClass.parent-class"></a>parent_class</code></em>;</p></td> +<td class="struct_member_description"><p>Parent class.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpicePlaybackChannelClass.playback-start"></a>playback_start</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannel-playback-start" title="The “playback-start” signal"><span class="type">“playback-start”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpicePlaybackChannelClass.playback-data"></a>playback_data</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannel-playback-data" title="The “playback-data” signal"><span class="type">“playback-data”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpicePlaybackChannelClass.playback-stop"></a>playback_stop</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannel-playback-stop" title="The “playback-stop” signal"><span class="type">“playback-stop”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="SpicePlaybackChannel.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="SpicePlaybackChannel--min-latency"></a><h3>The <code class="literal">“min-latency”</code> property</h3> +<pre class="programlisting"> “min-latency” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> +<p>Playback min buffer size (ms).</p> +<p>Flags: Read / Write</p> +<p>Default value: 200</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpicePlaybackChannel--mute"></a><h3>The <code class="literal">“mute”</code> property</h3> +<pre class="programlisting"> “mute” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Mute.</p> +<p>Flags: Read / Write</p> +<p>Default value: FALSE</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpicePlaybackChannel--nchannels"></a><h3>The <code class="literal">“nchannels”</code> property</h3> +<pre class="programlisting"> “nchannels” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> +<p>Number of Channels.</p> +<p>Flags: Read / Write</p> +<p>Allowed values: <= 255</p> +<p>Default value: 2</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpicePlaybackChannel--volume"></a><h3>The <code class="literal">“volume”</code> property</h3> +<pre class="programlisting"> “volume” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></pre> +<p>Playback volume.</p> +<p>Flags: Read / Write</p> +</div> +</div> +<div class="refsect1"> +<a name="SpicePlaybackChannel.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="SpicePlaybackChannel-playback-data"></a><h3>The <code class="literal">“playback-data”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpicePlaybackChannel.html" title="Playback Channel"><span class="type">SpicePlaybackChannel</span></a> *channel, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> data_size, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Provide audio data to be played.</p> +<div class="refsect3"> +<a name="id-1.2.3.8.14.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpicePlaybackChannel.html" title="Playback Channel"><span class="type">SpicePlaybackChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>pointer to audio data</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data_size</p></td> +<td class="parameter_description"><p>size in byte of <em class="parameter"><code>data</code></em> +</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpicePlaybackChannel-playback-get-delay"></a><h3>The <code class="literal">“playback-get-delay”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpicePlaybackChannel.html" title="Playback Channel"><span class="type">SpicePlaybackChannel</span></a> *channel, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Notify when the current playback delay is requested</p> +<div class="refsect3"> +<a name="id-1.2.3.8.14.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpicePlaybackChannel.html" title="Playback Channel"><span class="type">SpicePlaybackChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpicePlaybackChannel-playback-start"></a><h3>The <code class="literal">“playback-start”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpicePlaybackChannel.html" title="Playback Channel"><span class="type">SpicePlaybackChannel</span></a> *channel, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> format, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> channels, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> rate, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Notify when the playback should start, and provide audio format +characteristics.</p> +<div class="refsect3"> +<a name="id-1.2.3.8.14.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpicePlaybackChannel.html" title="Playback Channel"><span class="type">SpicePlaybackChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>format</p></td> +<td class="parameter_description"><p>a <span class="type">SPICE_AUDIO_FMT</span></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>channels</p></td> +<td class="parameter_description"><p>number of channels</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>rate</p></td> +<td class="parameter_description"><p>audio rate</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>latency</p></td> +<td class="parameter_description"><p>minimum playback latency in ms</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpicePlaybackChannel-playback-stop"></a><h3>The <code class="literal">“playback-stop”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpicePlaybackChannel.html" title="Playback Channel"><span class="type">SpicePlaybackChannel</span></a> *channel, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Notify when the playback should stop.</p> +<div class="refsect3"> +<a name="id-1.2.3.8.14.5.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpicePlaybackChannel.html" title="Playback Channel"><span class="type">SpicePlaybackChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +</div> +<div class="refsect1"> +<a name="SpicePlaybackChannel.see-also"></a><h2>See Also</h2> +<p><a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a>, and <a class="link" href="SpiceAudio.html" title="Spice Audio"><span class="type">SpiceAudio</span></a></p> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/SpicePortChannel.html b/content-extra/api/spice-gtk/SpicePortChannel.html new file mode 100644 index 0000000..a0015bb --- /dev/null +++ b/content-extra/api/spice-gtk/SpicePortChannel.html @@ -0,0 +1,465 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Port Channel: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="ch02.html" title="Session and Channels Objects, from spice-client-glib"> +<link rel="prev" href="SpiceUsbredirChannel.html" title="USB Redirection Channel"> +<link rel="next" href="SpiceWebdavChannel.html" title="WebDAV Channel"> +<meta name="generator" content="GTK-Doc V1.24 (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="#SpicePortChannel.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#SpicePortChannel.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#SpicePortChannel.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> + <a href="#SpicePortChannel.signals" class="shortcut">Signals</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="SpiceUsbredirChannel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="SpiceWebdavChannel.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="SpicePortChannel"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="SpicePortChannel.top_of_page"></a>Port Channel</span></h2> +<p>Port Channel — private communication channel</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="SpicePortChannel.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="SpicePortChannel.functions"></a><h2>Functions</h2> +<div class="informaltable"><table 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">void</span> +</td> +<td class="function_name"> +<a class="link" href="SpicePortChannel.html#spice-port-event" title="spice_port_event ()">spice_port_event</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="SpicePortChannel.html#spice-port-write-async" title="spice_port_write_async ()">spice_port_write_async</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"><span class="returnvalue">gssize</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpicePortChannel.html#spice-port-write-finish" title="spice_port_write_finish ()">spice_port_write_finish</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpicePortChannel.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="SpicePortChannel.html#SpicePortChannel--port-name" title="The “port-name” property">port-name</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpicePortChannel.html#SpicePortChannel--port-opened" title="The “port-opened” property">port-opened</a></td> +<td class="property_flags">Read</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpicePortChannel.signals"></a><h2>Signals</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="signals_return"> +<col width="300px" class="signals_name"> +<col width="200px" class="signals_flags"> +</colgroup> +<tbody> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpicePortChannel.html#SpicePortChannel-port-data" title="The “port-data” signal">port-data</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpicePortChannel.html#SpicePortChannel-port-event" title="The “port-event” signal">port-event</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpicePortChannel.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpicePortChannel.html#SpicePortChannel-struct" title="struct SpicePortChannel">SpicePortChannel</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpicePortChannel.html#SpicePortChannelClass" title="struct SpicePortChannelClass">SpicePortChannelClass</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpicePortChannel.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">╰──</span> <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> + <span class="lineart">╰──</span> SpicePortChannel + <span class="lineart">╰──</span> <a class="link" href="SpiceWebdavChannel.html" title="WebDAV Channel">SpiceWebdavChannel</a> +</pre> +</div> +<div class="refsect1"> +<a name="SpicePortChannel.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-client.h> +</pre> +</div> +<div class="refsect1"> +<a name="SpicePortChannel.description"></a><h2>Description</h2> +<p>A Spice port channel carry arbitrary data between the Spice client +and the Spice server. It may be used to provide additional +services on top of a Spice connection. For example, a channel can +be associated with the qemu monitor for the client to interact +with it, just like any qemu chardev. Or it may be used with +various protocols, such as the Spice Controller.</p> +<p>A port kind is identified simply by a fqdn, such as +org.qemu.monitor, org.spice.spicy.test or org.ovirt.controller...</p> +<p>Once connected and initialized, the client may read the name of the +port via SpicePortChannel:port-name.</p> +<p>When the other end of the port is ready, +SpicePortChannel:port-opened is set to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> and you can start +receiving data via the signal SpicePortChannel::port-data, or +sending data via <a class="link" href="SpicePortChannel.html#spice-port-write-async" title="spice_port_write_async ()"><code class="function">spice_port_write_async()</code></a>.</p> +</div> +<div class="refsect1"> +<a name="SpicePortChannel.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="spice-port-event"></a><h3>spice_port_event ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_port_event (<em class="parameter"><code><a class="link" href="SpicePortChannel.html" title="Port Channel"><span class="type">SpicePortChannel</span></a> *port</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> event</code></em>);</pre> +<p>Send an event to the port.</p> +<p>Note: The values SPICE_PORT_EVENT_CLOSED and +SPICE_PORT_EVENT_OPENED are managed by the channel connection +state.</p> +<div class="refsect3"> +<a name="id-1.2.3.12.11.2.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>port</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpicePortChannel.html" title="Port Channel"><span class="type">SpicePortChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>event</p></td> +<td class="parameter_description"><p>a SPICE_PORT_EVENT value</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: 0.15</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-port-write-async"></a><h3>spice_port_write_async ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_port_write_async (<em class="parameter"><code><a class="link" href="SpicePortChannel.html" title="Port Channel"><span class="type">SpicePortChannel</span></a> *port</code></em>, + <em class="parameter"><code>const <span class="type">void</span> *buffer</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> count</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> +<p>Request an asynchronous write of count bytes from <em class="parameter"><code>buffer</code></em> + into the +<em class="parameter"><code>port</code></em> +. When the operation is finished <em class="parameter"><code>callback</code></em> + will be called. You +can then call <a class="link" href="SpicePortChannel.html#spice-port-write-finish" title="spice_port_write_finish ()"><code class="function">spice_port_write_finish()</code></a> to get the result of +the operation.</p> +<div class="refsect3"> +<a name="id-1.2.3.12.11.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>port</p></td> +<td class="parameter_description"><p>A <a class="link" href="SpicePortChannel.html" title="Port Channel"><span class="type">SpicePortChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>buffer</p></td> +<td class="parameter_description"><p> the buffer +containing the data to write. </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=count][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>count</p></td> +<td class="parameter_description"><p>the number of bytes to write</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> optional GCancellable object, NULL to ignore. </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> +<tr> +<td class="parameter_name"><p>callback</p></td> +<td class="parameter_description"><p> callback to call when the request is satisfied. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p> the data to pass to callback function. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: 0.15</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-port-write-finish"></a><h3>spice_port_write_finish ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"><span class="returnvalue">gssize</span></a> +spice_port_write_finish (<em class="parameter"><code><a class="link" href="SpicePortChannel.html" title="Port Channel"><span class="type">SpicePortChannel</span></a> *port</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Finishes a port write operation.</p> +<div class="refsect3"> +<a name="id-1.2.3.12.11.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>port</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpicePortChannel.html" title="Port Channel"><span class="type">SpicePortChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>result</p></td> +<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> location to store the error occurring, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> +to ignore</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.3.12.11.4.6"></a><h4>Returns</h4> +<p> a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"><span class="type">gssize</span></a> containing the number of bytes written to the stream.</p> +</div> +<p class="since">Since: 0.15</p> +</div> +</div> +<div class="refsect1"> +<a name="SpicePortChannel.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SpicePortChannel-struct"></a><h3>struct SpicePortChannel</h3> +<pre class="programlisting">struct SpicePortChannel;</pre> +<p>The <a class="link" href="SpicePortChannel.html" title="Port Channel"><span class="type">SpicePortChannel</span></a> struct is opaque and should not be accessed directly.</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpicePortChannelClass"></a><h3>struct SpicePortChannelClass</h3> +<pre class="programlisting">struct SpicePortChannelClass { + SpiceChannelClass parent_class; +}; +</pre> +<p>Class structure for <a class="link" href="SpicePortChannel.html" title="Port Channel"><span class="type">SpicePortChannel</span></a>.</p> +<div class="refsect3"> +<a name="id-1.2.3.12.12.3.5"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody><tr> +<td class="struct_member_name"><p><a class="link" href="SpiceChannel.html#SpiceChannelClass" title="SpiceChannelClass"><span class="type">SpiceChannelClass</span></a> <em class="structfield"><code><a name="SpicePortChannelClass.parent-class"></a>parent_class</code></em>;</p></td> +<td class="struct_member_description"><p>Parent class.</p></td> +<td class="struct_member_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="SpicePortChannel.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="SpicePortChannel--port-name"></a><h3>The <code class="literal">“port-name”</code> property</h3> +<pre class="programlisting"> “port-name” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>Port name.</p> +<p>Flags: Read</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpicePortChannel--port-opened"></a><h3>The <code class="literal">“port-opened”</code> property</h3> +<pre class="programlisting"> “port-opened” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Port opened.</p> +<p>Flags: Read</p> +<p>Default value: FALSE</p> +</div> +</div> +<div class="refsect1"> +<a name="SpicePortChannel.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="SpicePortChannel-port-data"></a><h3>The <code class="literal">“port-data”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpicePortChannel.html" title="Port Channel"><span class="type">SpicePortChannel</span></a> *channel, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> size, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpicePortChannel.html#SpicePortChannel-port-data" title="The “port-data” signal"><span class="type">“port-data”</span></a> signal is emitted when new +port data is received.</p> +<div class="refsect3"> +<a name="id-1.2.3.12.14.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>the channel that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>the data received</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>size</p></td> +<td class="parameter_description"><p>number of bytes read</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p> +<p class="since">Since: 0.15</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpicePortChannel-port-event"></a><h3>The <code class="literal">“port-event”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpicePortChannel.html" title="Port Channel"><span class="type">SpicePortChannel</span></a> *channel, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> event, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpicePortChannel.html#SpicePortChannel-port-event" title="The “port-event” signal"><span class="type">“port-event”</span></a> signal is emitted when new +port event is received.</p> +<div class="refsect3"> +<a name="id-1.2.3.12.14.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>the channel that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>event</p></td> +<td class="parameter_description"><p>the event received</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>size</p></td> +<td class="parameter_description"><p>number of bytes read</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p> +<p class="since">Since: 0.15</p> +</div> +</div> +<div class="refsect1"> +<a name="SpicePortChannel.see-also"></a><h2>See Also</h2> +<p><a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a></p> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/SpiceRecordChannel.html b/content-extra/api/spice-gtk/SpiceRecordChannel.html new file mode 100644 index 0000000..2f547fd --- /dev/null +++ b/content-extra/api/spice-gtk/SpiceRecordChannel.html @@ -0,0 +1,372 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Record Channel: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="ch02.html" title="Session and Channels Objects, from spice-client-glib"> +<link rel="prev" href="SpicePlaybackChannel.html" title="Playback Channel"> +<link rel="next" href="SpiceSmartcardChannel.html" title="Smartcard Channel"> +<meta name="generator" content="GTK-Doc V1.24 (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="#SpiceRecordChannel.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#SpiceRecordChannel.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#SpiceRecordChannel.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> + <a href="#SpiceRecordChannel.signals" class="shortcut">Signals</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="SpicePlaybackChannel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="SpiceSmartcardChannel.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="SpiceRecordChannel"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="SpiceRecordChannel.top_of_page"></a>Record Channel</span></h2> +<p>Record Channel — audio stream for recording</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="SpiceRecordChannel.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="SpiceRecordChannel.functions"></a><h2>Functions</h2> +<div class="informaltable"><table 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">void</span> +</td> +<td class="function_name"> +<a class="link" href="SpiceRecordChannel.html#spice-record-send-data" title="spice_record_send_data ()">spice_record_send_data</a> <span class="c_punctuation">()</span> +</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceRecordChannel.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceRecordChannel.html#SpiceRecordChannel--mute" title="The “mute” property">mute</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> +<td class="property_name"><a class="link" href="SpiceRecordChannel.html#SpiceRecordChannel--nchannels" title="The “nchannels” property">nchannels</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></td> +<td class="property_name"><a class="link" href="SpiceRecordChannel.html#SpiceRecordChannel--volume" title="The “volume” property">volume</a></td> +<td class="property_flags">Read / Write</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceRecordChannel.signals"></a><h2>Signals</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="signals_return"> +<col width="300px" class="signals_name"> +<col width="200px" class="signals_flags"> +</colgroup> +<tbody> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceRecordChannel.html#SpiceRecordChannel-record-start" title="The “record-start” signal">record-start</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceRecordChannel.html#SpiceRecordChannel-record-stop" title="The “record-stop” signal">record-stop</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceRecordChannel.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceRecordChannel.html#SpiceRecordChannel-struct" title="struct SpiceRecordChannel">SpiceRecordChannel</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceRecordChannel.html#SpiceRecordChannelClass" title="struct SpiceRecordChannelClass">SpiceRecordChannelClass</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceRecordChannel.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">╰──</span> <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> + <span class="lineart">╰──</span> SpiceRecordChannel +</pre> +</div> +<div class="refsect1"> +<a name="SpiceRecordChannel.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-client.h> +</pre> +</div> +<div class="refsect1"> +<a name="SpiceRecordChannel.description"></a><h2>Description</h2> +<p><a class="link" href="SpiceRecordChannel.html" title="Record Channel"><span class="type">SpiceRecordChannel</span></a> class handles an audio recording stream. The +audio stream should start when <a class="link" href="SpiceRecordChannel.html#SpiceRecordChannel-record-start" title="The “record-start” signal"><span class="type">“record-start”</span></a> is +emitted and should be stopped when <a class="link" href="SpiceRecordChannel.html#SpiceRecordChannel-record-stop" title="The “record-stop” signal"><span class="type">“record-stop”</span></a> +is received.</p> +<p>The audio is sent to the guest by calling <a class="link" href="SpiceRecordChannel.html#spice-record-send-data" title="spice_record_send_data ()"><code class="function">spice_record_send_data()</code></a> +with the recorded PCM data.</p> +<p>Note: You may be interested to let the <a class="link" href="SpiceAudio.html" title="Spice Audio"><span class="type">SpiceAudio</span></a> class play and +record audio channels for your application.</p> +</div> +<div class="refsect1"> +<a name="SpiceRecordChannel.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="spice-record-send-data"></a><h3>spice_record_send_data ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_record_send_data (<em class="parameter"><code><a class="link" href="SpiceRecordChannel.html" title="Record Channel"><span class="type">SpiceRecordChannel</span></a> *channel</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> bytes</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> time</code></em>);</pre> +<p>Send recorded PCM data to the guest.</p> +<div class="refsect3"> +<a name="id-1.2.3.9.11.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceRecordChannel.html" title="Record Channel"><span class="type">SpiceRecordChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>PCM data</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>bytes</p></td> +<td class="parameter_description"><p>size of <em class="parameter"><code>data</code></em> +</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>time</p></td> +<td class="parameter_description"><p>stream timestamp</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="SpiceRecordChannel.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SpiceRecordChannel-struct"></a><h3>struct SpiceRecordChannel</h3> +<pre class="programlisting">struct SpiceRecordChannel;</pre> +<p>The <a class="link" href="SpiceRecordChannel.html" title="Record Channel"><span class="type">SpiceRecordChannel</span></a> struct is opaque and should not be accessed directly.</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceRecordChannelClass"></a><h3>struct SpiceRecordChannelClass</h3> +<pre class="programlisting">struct SpiceRecordChannelClass { + SpiceChannelClass parent_class; + + /* signals */ + void (*record_start)(SpiceRecordChannel *channel, + gint format, gint channels, gint freq); + void (*record_data)(SpiceRecordChannel *channel, gpointer *data, gint size); + void (*record_stop)(SpiceRecordChannel *channel); +}; +</pre> +<p>Class structure for <a class="link" href="SpiceRecordChannel.html" title="Record Channel"><span class="type">SpiceRecordChannel</span></a>.</p> +<div class="refsect3"> +<a name="id-1.2.3.9.12.3.5"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="struct_member_name"><p><a class="link" href="SpiceChannel.html#SpiceChannelClass" title="SpiceChannelClass"><span class="type">SpiceChannelClass</span></a> <em class="structfield"><code><a name="SpiceRecordChannelClass.parent-class"></a>parent_class</code></em>;</p></td> +<td class="struct_member_description"><p>Parent class.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceRecordChannelClass.record-start"></a>record_start</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceRecordChannel.html#SpiceRecordChannel-record-start" title="The “record-start” signal"><span class="type">“record-start”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceRecordChannelClass.record-data"></a>record_data</code></em> ()</p></td> +<td class="struct_member_description"><p>Unused (deprecated).</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceRecordChannelClass.record-stop"></a>record_stop</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceRecordChannel.html#SpiceRecordChannel-record-stop" title="The “record-stop” signal"><span class="type">“record-stop”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="SpiceRecordChannel.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="SpiceRecordChannel--mute"></a><h3>The <code class="literal">“mute”</code> property</h3> +<pre class="programlisting"> “mute” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Mute.</p> +<p>Flags: Read / Write</p> +<p>Default value: FALSE</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceRecordChannel--nchannels"></a><h3>The <code class="literal">“nchannels”</code> property</h3> +<pre class="programlisting"> “nchannels” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> +<p>Number of Channels.</p> +<p>Flags: Read / Write</p> +<p>Allowed values: <= 255</p> +<p>Default value: 2</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceRecordChannel--volume"></a><h3>The <code class="literal">“volume”</code> property</h3> +<pre class="programlisting"> “volume” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></pre> +<p>Record volume.</p> +<p>Flags: Read / Write</p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceRecordChannel.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="SpiceRecordChannel-record-start"></a><h3>The <code class="literal">“record-start”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceRecordChannel.html" title="Record Channel"><span class="type">SpiceRecordChannel</span></a> *channel, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> format, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> channels, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> rate, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Notify when the recording should start, and provide audio format +characteristics.</p> +<div class="refsect3"> +<a name="id-1.2.3.9.14.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceRecordChannel.html" title="Record Channel"><span class="type">SpiceRecordChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>format</p></td> +<td class="parameter_description"><p>a <span class="type">SPICE_AUDIO_FMT</span></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>channels</p></td> +<td class="parameter_description"><p>number of channels</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>rate</p></td> +<td class="parameter_description"><p>audio rate</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceRecordChannel-record-stop"></a><h3>The <code class="literal">“record-stop”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceRecordChannel.html" title="Record Channel"><span class="type">SpiceRecordChannel</span></a> *channel, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Notify when the recording should stop.</p> +<div class="refsect3"> +<a name="id-1.2.3.9.14.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>channel</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceRecordChannel.html" title="Record Channel"><span class="type">SpiceRecordChannel</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceRecordChannel.see-also"></a><h2>See Also</h2> +<p><a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a>, and <a class="link" href="SpiceAudio.html" title="Spice Audio"><span class="type">SpiceAudio</span></a></p> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/SpiceSession.html b/content-extra/api/spice-gtk/SpiceSession.html new file mode 100644 index 0000000..d5c3f5b --- /dev/null +++ b/content-extra/api/spice-gtk/SpiceSession.html @@ -0,0 +1,1393 @@ +<!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 Session: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="ch02.html" title="Session and Channels Objects, from spice-client-glib"> +<link rel="prev" href="ch02.html" title="Session and Channels Objects, from spice-client-glib"> +<link rel="next" href="SpiceChannel.html" title="Spice Channel"> +<meta name="generator" content="GTK-Doc V1.24 (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="#SpiceSession.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#SpiceSession.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#SpiceSession.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> + <a href="#SpiceSession.signals" class="shortcut">Signals</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="ch02.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="SpiceChannel.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="SpiceSession"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="SpiceSession.top_of_page"></a>Spice Session</span></h2> +<p>Spice Session — handles connection details, and active channels</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="SpiceSession.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="SpiceSession.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<a class="link" href="SpiceSession.html" title="Spice Session"><span class="returnvalue">SpiceSession</span></a> * +</td> +<td class="function_name"> +<a class="link" href="SpiceSession.html#spice-session-new" title="spice_session_new ()">spice_session_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceSession.html#spice-session-connect" title="spice_session_connect ()">spice_session_connect</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceSession.html#spice-session-open-fd" title="spice_session_open_fd ()">spice_session_open_fd</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="SpiceSession.html#spice-session-disconnect" title="spice_session_disconnect ()">spice_session_disconnect</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * +</td> +<td class="function_name"> +<a class="link" href="SpiceSession.html#spice-session-get-channels" title="spice_session_get_channels ()">spice_session_get_channels</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceSession.html#spice-session-get-read-only" title="spice_session_get_read_only ()">spice_session_get_read_only</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceSession.html#spice-session-has-channel-type" title="spice_session_has_channel_type ()">spice_session_has_channel_type</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="returnvalue">SpiceURI</span></a> * +</td> +<td class="function_name"> +<a class="link" href="SpiceSession.html#spice-session-get-proxy-uri" title="spice_session_get_proxy_uri ()">spice_session_get_proxy_uri</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceSession.html#spice-session-is-for-migration" title="spice_session_is_for_migration ()">spice_session_is_for_migration</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Commandline-option-parser.html#GOptionGroup"><span class="returnvalue">GOptionGroup</span></a> * +</td> +<td class="function_name"> +<a class="link" href="SpiceSession.html#spice-get-option-group" title="spice_get_option_group ()">spice_get_option_group</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="SpiceSession.html#spice-set-session-option" title="spice_set_session_option ()">spice_set_session_option</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceSession.html#spice-client-error-quark" title="spice_client_error_quark ()">spice_client_error_quark</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceSession.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Byte-Arrays.html#GByteArray"><span class="type">GByteArray</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--ca" title="The “ca” property">ca</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--ca-file" title="The “ca-file” property">ca-file</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--cache-size" title="The “cache-size” property">cache-size</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--cert-subject" title="The “cert-subject” property">cert-subject</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--ciphers" title="The “ciphers” property">ciphers</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--client-sockets" title="The “client-sockets” property">client-sockets</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--color-depth" title="The “color-depth” property">color-depth</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--disable-effects" title="The “disable-effects” property">disable-effects</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--enable-audio" title="The “enable-audio” property">enable-audio</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--enable-smartcard" title="The “enable-smartcard” property">enable-smartcard</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--enable-usbredir" title="The “enable-usbredir” property">enable-usbredir</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--glz-window-size" title="The “glz-window-size” property">glz-window-size</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--host" title="The “host” property">host</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--inhibit-keyboard-grab" title="The “inhibit-keyboard-grab” property">inhibit-keyboard-grab</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><a class="link" href="SpiceSession.html#SpiceSessionMigration" title="enum SpiceSessionMigration"><span class="type">SpiceSessionMigration</span></a></td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--migration-state" title="The “migration-state” property">migration-state</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--name" title="The “name” property">name</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--password" title="The “password” property">password</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--port" title="The “port” property">port</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><span class="type">SpiceImageCompress</span></td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--preferred-compression" title="The “preferred-compression” property">preferred-compression</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--protocol" title="The “protocol” property">protocol</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--proxy" title="The “proxy” property">proxy</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Byte-Arrays.html#GByteArray"><span class="type">GByteArray</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--pubkey" title="The “pubkey” property">pubkey</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--read-only" title="The “read-only” property">read-only</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--secure-channels" title="The “secure-channels” property">secure-channels</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--share-dir-ro" title="The “share-dir-ro” property">share-dir-ro</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--shared-dir" title="The “shared-dir” property">shared-dir</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--smartcard-certificates" title="The “smartcard-certificates” property">smartcard-certificates</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--smartcard-db" title="The “smartcard-db” property">smartcard-db</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--tls-port" title="The “tls-port” property">tls-port</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--unix-path" title="The “unix-path” property">unix-path</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--uri" title="The “uri” property">uri</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--username" title="The “username” property">username</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--uuid" title="The “uuid” property">uuid</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a class="link" href="SpiceSession.html#SpiceSessionVerify" title="enum SpiceSessionVerify"><span class="type">SpiceSessionVerify</span></a></td> +<td class="property_name"><a class="link" href="SpiceSession.html#SpiceSession--verify" title="The “verify” property">verify</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceSession.signals"></a><h2>Signals</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="signals_return"> +<col width="300px" class="signals_name"> +<col width="200px" class="signals_flags"> +</colgroup> +<tbody> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceSession.html#SpiceSession-channel-destroy" title="The “channel-destroy” signal">channel-destroy</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceSession.html#SpiceSession-channel-new" title="The “channel-new” signal">channel-new</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceSession.html#SpiceSession-mm-time-reset" title="The “mm-time-reset” signal">mm-time-reset</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceSession.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="SpiceSession.html#SpiceSession-struct" title="SpiceSession">SpiceSession</a></td> +</tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="SpiceSession.html#SpiceSessionClass" title="SpiceSessionClass">SpiceSessionClass</a></td> +</tr> +<tr> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="SpiceSession.html#SpiceSessionMigration" title="enum SpiceSessionMigration">SpiceSessionMigration</a></td> +</tr> +<tr> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="SpiceSession.html#SpiceSessionVerify" title="enum SpiceSessionVerify">SpiceSessionVerify</a></td> +</tr> +<tr> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="SpiceSession.html#SpiceClientError" title="enum SpiceClientError">SpiceClientError</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="SpiceSession.html#SPICE-CLIENT-ERROR:CAPS" title="SPICE_CLIENT_ERROR">SPICE_CLIENT_ERROR</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceSession.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a> + <span class="lineart">╰──</span> SpiceSessionMigration + <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GFlags</a> + <span class="lineart">╰──</span> SpiceSessionVerify + <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">╰──</span> SpiceSession +</pre> +</div> +<div class="refsect1"> +<a name="SpiceSession.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-client.h> +</pre> +</div> +<div class="refsect1"> +<a name="SpiceSession.description"></a><h2>Description</h2> +<p>The <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> class handles all the <a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a> connections. +It's also the class that contains connections informations, such as +<a class="link" href="SpiceSession.html#SpiceSession--host" title="The “host” property"><span class="type">“host”</span></a> and <a class="link" href="SpiceSession.html#SpiceSession--port" title="The “port” property"><span class="type">“port”</span></a>.</p> +<p>You can simply set the property <a class="link" href="SpiceSession.html#SpiceSession--uri" title="The “uri” property"><span class="type">“uri”</span></a> to something like +"spice://127.0.0.1?port=5930" to configure your connection details.</p> +<p>You may want to connect to <a class="link" href="SpiceSession.html#SpiceSession-channel-new" title="The “channel-new” signal"><span class="type">“channel-new”</span></a> signal, to be +informed of the availability of channels and to interact with +them.</p> +<p>For example, when the <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel"><span class="type">SpiceInputsChannel</span></a> is available and get the +event <a class="link" href="SpiceChannel.html#SPICE-CHANNEL-OPENED:CAPS"><span class="type">SPICE_CHANNEL_OPENED</span></a>, you can send key events with +<a class="link" href="SpiceInputsChannel.html#spice-inputs-key-press" title="spice_inputs_key_press ()"><code class="function">spice_inputs_key_press()</code></a>. When the <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> is available, +you can start sharing the clipboard... .</p> +<p>Once <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> properties set, you can call +<a class="link" href="SpiceSession.html#spice-session-connect" title="spice_session_connect ()"><code class="function">spice_session_connect()</code></a> to start connecting and communicating with +a Spice server.</p> +</div> +<div class="refsect1"> +<a name="SpiceSession.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="spice-session-new"></a><h3>spice_session_new ()</h3> +<pre class="programlisting"><a class="link" href="SpiceSession.html" title="Spice Session"><span class="returnvalue">SpiceSession</span></a> * +spice_session_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p>Creates a new Spice session.</p> +<div class="refsect3"> +<a name="id-1.2.3.2.11.2.5"></a><h4>Returns</h4> +<p> a new <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-session-connect"></a><h3>spice_session_connect ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +spice_session_connect (<em class="parameter"><code><a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> *session</code></em>);</pre> +<p>Open the session using the <a class="link" href="SpiceSession.html#SpiceSession--host" title="The “host” property"><span class="type">“host”</span></a> and +<a class="link" href="SpiceSession.html#SpiceSession--port" title="The “port” property"><span class="type">“port”</span></a>.</p> +<div class="refsect3"> +<a name="id-1.2.3.2.11.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.3.2.11.3.6"></a><h4>Returns</h4> +<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the session state is invalid for connection +request. <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the connection is initiated. To know whether the +connection is established, you must watch for channels creation +(<a class="link" href="SpiceSession.html#SpiceSession-channel-new" title="The “channel-new” signal"><span class="type">“channel-new”</span></a>) and the channels state +(<a class="link" href="SpiceChannel.html#SpiceChannel-channel-event" title="The “channel-event” signal"><span class="type">“channel-event”</span></a>).</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-session-open-fd"></a><h3>spice_session_open_fd ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +spice_session_open_fd (<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> fd</code></em>);</pre> +<p>Open the session using the provided <em class="parameter"><code>fd</code></em> + socket file +descriptor. This is useful if you create the fd yourself, for +example to setup a SSH tunnel.</p> +<p>Note however that additional sockets will be needed by all the channels +created for <em class="parameter"><code>session</code></em> + so users of this API should hook into +SpiceChannel::open-fd signal for each channel they are interested in, and +create and pass a new socket to the channel using <a class="link" href="SpiceChannel.html#spice-channel-open-fd" title="spice_channel_open_fd ()"><span class="type">spice_channel_open_fd</span></a>, in +the signal callback.</p> +<p>If <em class="parameter"><code>fd</code></em> + is -1, a valid fd will be requested later via the +SpiceChannel::open-fd signal. Typically, you would want to just pass -1 as +<em class="parameter"><code>fd</code></em> + this call since you will have to hook to SpiceChannel::open-fd signal +anyway.</p> +<div class="refsect3"> +<a name="id-1.2.3.2.11.4.7"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>fd</p></td> +<td class="parameter_description"><p>a file descriptor (socket) or -1</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.3.2.11.4.8"></a><h4>Returns</h4> +<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-session-disconnect"></a><h3>spice_session_disconnect ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_session_disconnect (<em class="parameter"><code><a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> *session</code></em>);</pre> +<p>Disconnect the <em class="parameter"><code>session</code></em> +, and destroy all channels.</p> +<div class="refsect3"> +<a name="id-1.2.3.2.11.5.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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></tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-session-get-channels"></a><h3>spice_session_get_channels ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * +spice_session_get_channels (<em class="parameter"><code><a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> *session</code></em>);</pre> +<p>Get the list of current channels associated with this <em class="parameter"><code>session</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.2.3.2.11.6.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.3.2.11.6.6"></a><h4>Returns</h4> +<p> a <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> +of unowned <a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a> channels. </p> +<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> SpiceChannel][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-session-get-read-only"></a><h3>spice_session_get_read_only ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +spice_session_get_read_only (<em class="parameter"><code><a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> *session</code></em>);</pre> +<p>Checks whether the <em class="parameter"><code>session</code></em> + is read-only.</p> +<div class="refsect3"> +<a name="id-1.2.3.2.11.7.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.3.2.11.7.6"></a><h4>Returns</h4> +<p> whether the <em class="parameter"><code>session</code></em> +is in read-only mode.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-session-has-channel-type"></a><h3>spice_session_has_channel_type ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +spice_session_has_channel_type (<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/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> type</code></em>);</pre> +<p>See if there is a <em class="parameter"><code>type</code></em> + channel in the channels associated with this +<em class="parameter"><code>session</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.2.3.2.11.8.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>type</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceChannel.html#SpiceChannel--channel-type" title="The “channel-type” property"><span class="type">“channel-type”</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.3.2.11.8.6"></a><h4>Returns</h4> +<p> TRUE if a <em class="parameter"><code>type</code></em> +channel is available otherwise FALSE.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-session-get-proxy-uri"></a><h3>spice_session_get_proxy_uri ()</h3> +<pre class="programlisting"><a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="returnvalue">SpiceURI</span></a> * +spice_session_get_proxy_uri (<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 <em class="parameter"><code>session</code></em> + proxy uri.</p> +<div class="refsect3"> +<a name="id-1.2.3.2.11.9.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.3.2.11.9.6"></a><h4>Returns</h4> +<p> the session proxy <a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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> +<p class="since">Since: 0.24</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-session-is-for-migration"></a><h3>spice_session_is_for_migration ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +spice_session_is_for_migration (<em class="parameter"><code><a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> *session</code></em>);</pre> +<p>During seamless migration, channels may be created to establish a +connection with the target, but they are temporary and should only +handle migration steps. In order to avoid other interactions with +the client, channels should check this value.</p> +<div class="refsect3"> +<a name="id-1.2.3.2.11.10.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 Spice session</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.3.2.11.10.6"></a><h4>Returns</h4> +<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the session is a copy created during migration</p> +</div> +<p class="since">Since: 0.27</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-get-option-group"></a><h3>spice_get_option_group ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Commandline-option-parser.html#GOptionGroup"><span class="returnvalue">GOptionGroup</span></a> * +spice_get_option_group (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p>Gets commandline options.</p> +<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> +<div class="refsect3"> +<a name="id-1.2.3.2.11.11.6"></a><h4>Returns</h4> +<p> a <a href="/usr/share/gtk-doc/html/glib/glib-Commandline-option-parser.html#GOptionGroup"><span class="type">GOptionGroup</span></a> for the commandline +arguments specific to Spice. You have to call +<a class="link" href="SpiceSession.html#spice-set-session-option" title="spice_set_session_option ()"><code class="function">spice_set_session_option()</code></a> after to set the options on a +<a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a>. </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-set-session-option"></a><h3>spice_set_session_option ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_set_session_option (<em class="parameter"><code><a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> *session</code></em>);</pre> +<p>Set various properties on <em class="parameter"><code>session</code></em> +, according to the commandline +arguments given to <a class="link" href="SpiceSession.html#spice-get-option-group" title="spice_get_option_group ()"><code class="function">spice_get_option_group()</code></a> option group.</p> +<div class="refsect3"> +<a name="id-1.2.3.2.11.12.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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> to set option upon</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-client-error-quark"></a><h3>spice_client_error_quark ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> +spice_client_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p>Gets a <a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> representing the string "spice-client-error-quark"</p> +<div class="refsect3"> +<a name="id-1.2.3.2.11.13.5"></a><h4>Returns</h4> +<p> the <a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> representing the string.</p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="SpiceSession.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SpiceSession-struct"></a><h3>SpiceSession</h3> +<pre class="programlisting">typedef struct _SpiceSession SpiceSession;</pre> +<p>The <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> struct is opaque and should not be accessed directly.</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSessionClass"></a><h3>SpiceSessionClass</h3> +<pre class="programlisting">typedef struct { + GObjectClass parent_class; + + /* signals */ + void (*channel_new)(SpiceSession *session, SpiceChannel *channel); + void (*channel_destroy)(SpiceSession *session, SpiceChannel *channel); +} SpiceSessionClass; +</pre> +<p>Class structure for <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a>.</p> +<div class="refsect3"> +<a name="id-1.2.3.2.12.3.5"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="SpiceSessionClass.parent-class"></a>parent_class</code></em>;</p></td> +<td class="struct_member_description"><p>Parent class.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceSessionClass.channel-new"></a>channel_new</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceSession.html#SpiceSession-channel-new" title="The “channel-new” signal"><span class="type">“channel_new”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceSessionClass.channel-destroy"></a>channel_destroy</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceSession.html#SpiceSession-channel-destroy" title="The “channel-destroy” signal"><span class="type">“channel_destroy”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSessionMigration"></a><h3>enum SpiceSessionMigration</h3> +<p>Session migration state.</p> +<div class="refsect3"> +<a name="id-1.2.3.2.12.4.4"></a><h4>Members</h4> +<div class="informaltable"><table 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-SESSION-MIGRATION-NONE:CAPS"></a>SPICE_SESSION_MIGRATION_NONE</p></td> +<td class="enum_member_description"> +<p>no migration going on</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="SPICE-SESSION-MIGRATION-SWITCHING:CAPS"></a>SPICE_SESSION_MIGRATION_SWITCHING</p></td> +<td class="enum_member_description"> +<p>the session is switching host (destroy and reconnect)</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="SPICE-SESSION-MIGRATION-MIGRATING:CAPS"></a>SPICE_SESSION_MIGRATION_MIGRATING</p></td> +<td class="enum_member_description"> +<p>the session is migrating seamlessly (reconnect)</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="SPICE-SESSION-MIGRATION-CONNECTING:CAPS"></a>SPICE_SESSION_MIGRATION_CONNECTING</p></td> +<td class="enum_member_description"> +<p>the migration is connecting to destination (Since: 0.27)</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSessionVerify"></a><h3>enum SpiceSessionVerify</h3> +<p>Peer certificate verification parameters flags.</p> +<div class="refsect3"> +<a name="id-1.2.3.2.12.5.4"></a><h4>Members</h4> +<div class="informaltable"><table 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-SESSION-VERIFY-PUBKEY:CAPS"></a>SPICE_SESSION_VERIFY_PUBKEY</p></td> +<td class="enum_member_description"> +<p>verify certificate public key matching</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="SPICE-SESSION-VERIFY-HOSTNAME:CAPS"></a>SPICE_SESSION_VERIFY_HOSTNAME</p></td> +<td class="enum_member_description"> +<p>verify certificate hostname matching</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="SPICE-SESSION-VERIFY-SUBJECT:CAPS"></a>SPICE_SESSION_VERIFY_SUBJECT</p></td> +<td class="enum_member_description"> +<p>verify certificate subject matching</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceClientError"></a><h3>enum SpiceClientError</h3> +<p>Error codes returned by spice-client API.</p> +<div class="refsect3"> +<a name="id-1.2.3.2.12.6.4"></a><h4>Members</h4> +<div class="informaltable"><table 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-CLIENT-ERROR-FAILED:CAPS"></a>SPICE_CLIENT_ERROR_FAILED</p></td> +<td class="enum_member_description"> +<p>generic error code</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="SPICE-CLIENT-ERROR-USB-DEVICE-REJECTED:CAPS"></a>SPICE_CLIENT_ERROR_USB_DEVICE_REJECTED</p></td> +<td class="enum_member_description"> +<p>device redirection rejected by host</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="SPICE-CLIENT-ERROR-USB-DEVICE-LOST:CAPS"></a>SPICE_CLIENT_ERROR_USB_DEVICE_LOST</p></td> +<td class="enum_member_description"> +<p>device disconnected (fatal IO error)</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="SPICE-CLIENT-ERROR-AUTH-NEEDS-PASSWORD:CAPS"></a>SPICE_CLIENT_ERROR_AUTH_NEEDS_PASSWORD</p></td> +<td class="enum_member_description"> +<p>password is required</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="SPICE-CLIENT-ERROR-AUTH-NEEDS-PASSWORD-AND-USERNAME:CAPS"></a>SPICE_CLIENT_ERROR_AUTH_NEEDS_PASSWORD_AND_USERNAME</p></td> +<td class="enum_member_description"> +<p>password and username are required</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="SPICE-CLIENT-ERROR-USB-SERVICE:CAPS"></a>SPICE_CLIENT_ERROR_USB_SERVICE</p></td> +<td class="enum_member_description"> +<p>USB service error</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="SPICE-CLIENT-ERROR:CAPS"></a><h3>SPICE_CLIENT_ERROR</h3> +<pre class="programlisting">#define SPICE_CLIENT_ERROR spice_client_error_quark() +</pre> +<p>Error domain for spice client errors.</p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceSession.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="SpiceSession--ca"></a><h3>The <code class="literal">“ca”</code> property</h3> +<pre class="programlisting"> “ca” <a href="/usr/share/gtk-doc/html/glib/glib-Byte-Arrays.html#GByteArray"><span class="type">GByteArray</span></a> *</pre> +<p>CA certificates in PEM format. The text data can contain +several CA certificates identified by:</p> +<p> -----BEGIN CERTIFICATE----- + ... (CA certificate in base64 encoding) ... + -----END CERTIFICATE-----</p> +<p>Flags: Read / Write</p> +<p class="since">Since: 0.15</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--ca-file"></a><h3>The <code class="literal">“ca-file”</code> property</h3> +<pre class="programlisting"> “ca-file” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>File holding the CA certificates for the host the client is +connecting to</p> +<p>Flags: Read / Write</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--cache-size"></a><h3>The <code class="literal">“cache-size”</code> property</h3> +<pre class="programlisting"> “cache-size” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> +<p>Images cache size. If 0, don't set.</p> +<p>Flags: Read / Write</p> +<p>Allowed values: >= 0</p> +<p>Default value: 0</p> +<p class="since">Since: 0.9</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--cert-subject"></a><h3>The <code class="literal">“cert-subject”</code> property</h3> +<pre class="programlisting"> “cert-subject” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>Certificate subject to check.</p> +<p>Flags: Read / Write</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--ciphers"></a><h3>The <code class="literal">“ciphers”</code> property</h3> +<pre class="programlisting"> “ciphers” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>SSL cipher list.</p> +<p>Flags: Read / Write</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--client-sockets"></a><h3>The <code class="literal">“client-sockets”</code> property</h3> +<pre class="programlisting"> “client-sockets” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Sockets are provided by the client.</p> +<p>Flags: Read / Write</p> +<p>Default value: FALSE</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--color-depth"></a><h3>The <code class="literal">“color-depth”</code> property</h3> +<pre class="programlisting"> “color-depth” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> +<p>Display color depth to set on new display channels. If 0, don't set.</p> +<p>Flags: Read / Write</p> +<p>Allowed values: [0,32]</p> +<p>Default value: 0</p> +<p class="since">Since: 0.7</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--disable-effects"></a><h3>The <code class="literal">“disable-effects”</code> property</h3> +<pre class="programlisting"> “disable-effects” <a href="/usr/share/gtk-doc/html/glib/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></pre> +<p>A string array of effects to disable. The settings will +be applied on new display channels. The following effets can be +disabled "wallpaper", "font-smooth", "animation", and "all", +which will disable all the effects. If NULL, don't apply changes.</p> +<p>Flags: Read / Write</p> +<p class="since">Since: 0.7</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--enable-audio"></a><h3>The <code class="literal">“enable-audio”</code> property</h3> +<pre class="programlisting"> “enable-audio” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>If set to TRUE, the audio channels will be enabled for +playback and recording.</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: TRUE</p> +<p class="since">Since: 0.8</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--enable-smartcard"></a><h3>The <code class="literal">“enable-smartcard”</code> property</h3> +<pre class="programlisting"> “enable-smartcard” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>If set to TRUE, the smartcard channel will be enabled and smartcard +events will be forwarded to the guest</p> +<p>Flags: Read / Write</p> +<p>Default value: FALSE</p> +<p class="since">Since: 0.7</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--enable-usbredir"></a><h3>The <code class="literal">“enable-usbredir”</code> property</h3> +<pre class="programlisting"> “enable-usbredir” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>If set to TRUE, the usbredir channel will be enabled and USB devices +can be redirected to the guest</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: TRUE</p> +<p class="since">Since: 0.8</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--glz-window-size"></a><h3>The <code class="literal">“glz-window-size”</code> property</h3> +<pre class="programlisting"> “glz-window-size” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> +<p>Glz window size. If 0, don't set.</p> +<p>Flags: Read / Write</p> +<p>Allowed values: [0,134217728]</p> +<p>Default value: 0</p> +<p class="since">Since: 0.9</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--host"></a><h3>The <code class="literal">“host”</code> property</h3> +<pre class="programlisting"> “host” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>URL of the SPICE host to connect to</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: "localhost"</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--inhibit-keyboard-grab"></a><h3>The <code class="literal">“inhibit-keyboard-grab”</code> property</h3> +<pre class="programlisting"> “inhibit-keyboard-grab” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Request that SpiceDisplays don't grab the keyboard.</p> +<p>Flags: Read / Write</p> +<p>Default value: FALSE</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--migration-state"></a><h3>The <code class="literal">“migration-state”</code> property</h3> +<pre class="programlisting"> “migration-state” <a class="link" href="SpiceSession.html#SpiceSessionMigration" title="enum SpiceSessionMigration"><span class="type">SpiceSessionMigration</span></a></pre> +<p><a class="link" href="SpiceSession.html#SpiceSessionMigration" title="enum SpiceSessionMigration"><span class="type">SpiceSessionMigration</span></a> bit field indicating if a migration is in +progress</p> +<p>Flags: Read</p> +<p>Default value: SPICE_SESSION_MIGRATION_NONE</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--name"></a><h3>The <code class="literal">“name”</code> property</h3> +<pre class="programlisting"> “name” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>Spice server name.</p> +<p>Flags: Read</p> +<p>Default value: NULL</p> +<p class="since">Since: 0.11</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--password"></a><h3>The <code class="literal">“password”</code> property</h3> +<pre class="programlisting"> “password” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>TLS password to use</p> +<p>Flags: Read / Write</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--port"></a><h3>The <code class="literal">“port”</code> property</h3> +<pre class="programlisting"> “port” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>Port to connect to for unencrypted sessions</p> +<p>Flags: Read / Write</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--preferred-compression"></a><h3>The <code class="literal">“preferred-compression”</code> property</h3> +<pre class="programlisting"> “preferred-compression” <span class="type">SpiceImageCompress</span></pre> +<p>The image compression algorithm the client prefers to use. It is +reported to the server.</p> +<p>Flags: Read / Write</p> +<p>Default value: SPICE_IMAGE_COMPRESSION_INVALID</p> +<p class="since">Since: 0.29</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--protocol"></a><h3>The <code class="literal">“protocol”</code> property</h3> +<pre class="programlisting"> “protocol” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> +<p>Version of the SPICE protocol to use</p> +<p>Flags: Read / Write / Construct</p> +<p>Allowed values: [1,2]</p> +<p>Default value: 2</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--proxy"></a><h3>The <code class="literal">“proxy”</code> property</h3> +<pre class="programlisting"> “proxy” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>URI to the proxy server to use when doing network connection. +of the form [protocol://]<host>[:port] </p> +<p>Flags: Read / Write</p> +<p>Default value: NULL</p> +<p class="since">Since: 0.17</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--pubkey"></a><h3>The <code class="literal">“pubkey”</code> property</h3> +<pre class="programlisting"> “pubkey” <a href="/usr/share/gtk-doc/html/glib/glib-Byte-Arrays.html#GByteArray"><span class="type">GByteArray</span></a> *</pre> +<p>Public key to check.</p> +<p>Flags: Read / Write</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--read-only"></a><h3>The <code class="literal">“read-only”</code> property</h3> +<pre class="programlisting"> “read-only” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Whether this connection is read-only mode.</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: FALSE</p> +<p class="since">Since: 0.8</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--secure-channels"></a><h3>The <code class="literal">“secure-channels”</code> property</h3> +<pre class="programlisting"> “secure-channels” <a href="/usr/share/gtk-doc/html/glib/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></pre> +<p>A string array of channel types to be secured.</p> +<p>Flags: Read / Write</p> +<p class="since">Since: 0.20</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--share-dir-ro"></a><h3>The <code class="literal">“share-dir-ro”</code> property</h3> +<pre class="programlisting"> “share-dir-ro” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Whether to share the directory read-only.</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: FALSE</p> +<p class="since">Since: 0.28</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--shared-dir"></a><h3>The <code class="literal">“shared-dir”</code> property</h3> +<pre class="programlisting"> “shared-dir” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>Location of the shared directory</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: "/home/vtosodec/Public"</p> +<p class="since">Since: 0.24</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--smartcard-certificates"></a><h3>The <code class="literal">“smartcard-certificates”</code> property</h3> +<pre class="programlisting"> “smartcard-certificates” <a href="/usr/share/gtk-doc/html/glib/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></pre> +<p>This property is used when one wants to simulate a smartcard with no +hardware smartcard reader. If it's set to a NULL-terminated string +array containing the names of 3 valid certificates, these will be +used to simulate a smartcard in the guest +See also <a class="link" href="SpiceSmartcardManager.html#spice-smartcard-manager-insert-card" title="spice_smartcard_manager_insert_card ()"><code class="function">spice_smartcard_manager_insert_card()</code></a></p> +<p>Flags: Read / Write</p> +<p class="since">Since: 0.7</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--smartcard-db"></a><h3>The <code class="literal">“smartcard-db”</code> property</h3> +<pre class="programlisting"> “smartcard-db” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>Path to the NSS certificate database containing the certificates to +use to simulate a software smartcard</p> +<p>Flags: Read / Write</p> +<p>Default value: NULL</p> +<p class="since">Since: 0.7</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--tls-port"></a><h3>The <code class="literal">“tls-port”</code> property</h3> +<pre class="programlisting"> “tls-port” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>Port to connect to for TLS sessions</p> +<p>Flags: Read / Write</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--unix-path"></a><h3>The <code class="literal">“unix-path”</code> property</h3> +<pre class="programlisting"> “unix-path” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>Path of the Unix socket to connect to</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: NULL</p> +<p class="since">Since: 0.28</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--uri"></a><h3>The <code class="literal">“uri”</code> property</h3> +<pre class="programlisting"> “uri” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>URI of the SPICE host to connect to. The URI is of the form +spice://hostname?port=XXX or spice://hostname?tls_port=XXX</p> +<p>Flags: Read / Write</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--username"></a><h3>The <code class="literal">“username”</code> property</h3> +<pre class="programlisting"> “username” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>Username to use</p> +<p>Flags: Read / Write</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--uuid"></a><h3>The <code class="literal">“uuid”</code> property</h3> +<pre class="programlisting"> “uuid” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></pre> +<p>Spice server uuid.</p> +<p>Flags: Read</p> +<p class="since">Since: 0.11</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession--verify"></a><h3>The <code class="literal">“verify”</code> property</h3> +<pre class="programlisting"> “verify” <a class="link" href="SpiceSession.html#SpiceSessionVerify" title="enum SpiceSessionVerify"><span class="type">SpiceSessionVerify</span></a></pre> +<p><a class="link" href="SpiceSession.html#SpiceSessionVerify" title="enum SpiceSessionVerify"><span class="type">SpiceSessionVerify</span></a> bit field indicating which parts of the peer +certificate should be checked</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: SPICE_SESSION_VERIFY_HOSTNAME</p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceSession.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="SpiceSession-channel-destroy"></a><h3>The <code class="literal">“channel-destroy”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> *session, + <a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a> *channel, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpiceSession.html#SpiceSession-channel-destroy" title="The “channel-destroy” signal"><span class="type">“channel-destroy”</span></a> signal is emitted each time a <a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a> is destroyed.</p> +<div class="refsect3"> +<a name="id-1.2.3.2.14.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>the session that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>channel</p></td> +<td class="parameter_description"><p>the destroyed <a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession-channel-new"></a><h3>The <code class="literal">“channel-new”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> *session, + <a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a> *channel, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpiceSession.html#SpiceSession-channel-new" title="The “channel-new” signal"><span class="type">“channel-new”</span></a> signal is emitted each time a <a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a> is created.</p> +<div class="refsect3"> +<a name="id-1.2.3.2.14.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>the session that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>channel</p></td> +<td class="parameter_description"><p>the new <a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSession-mm-time-reset"></a><h3>The <code class="literal">“mm-time-reset”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> *session, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpiceSession.html#SpiceSession-mm-time-reset" title="The “mm-time-reset” signal"><span class="type">“mm-time-reset”</span></a> is emitted when we identify discontinuity in mm-time</p> +<p>Since 0.20</p> +<div class="refsect3"> +<a name="id-1.2.3.2.14.4.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>the session that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceSession.see-also"></a><h2>See Also</h2> +<p><a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a>, and the GTK widget <a class="link" href="SpiceDisplay.html" title="Spice Display"><span class="type">SpiceDisplay</span></a></p> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/SpiceSmartcardChannel.html b/content-extra/api/spice-gtk/SpiceSmartcardChannel.html new file mode 100644 index 0000000..0068b4f --- /dev/null +++ b/content-extra/api/spice-gtk/SpiceSmartcardChannel.html @@ -0,0 +1,128 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Smartcard Channel: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="ch02.html" title="Session and Channels Objects, from spice-client-glib"> +<link rel="prev" href="SpiceRecordChannel.html" title="Record Channel"> +<link rel="next" href="SpiceUsbredirChannel.html" title="USB Redirection Channel"> +<meta name="generator" content="GTK-Doc V1.24 (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="#SpiceSmartcardChannel.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#SpiceSmartcardChannel.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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="SpiceRecordChannel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="SpiceUsbredirChannel.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="SpiceSmartcardChannel"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="SpiceSmartcardChannel.top_of_page"></a>Smartcard Channel</span></h2> +<p>Smartcard Channel — smartcard authentication</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="SpiceSmartcardChannel.stability-level"></a><h2>Stability Level</h2> +<a href="http://foldoc.org/API%20Stable%20(channel%20in%20development)"><span class="acronym">API Stable (channel in development)</span></a>, unless otherwise indicated +</div> +<div class="refsect1"> +<a name="SpiceSmartcardChannel.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceSmartcardChannel.html#SpiceSmartcardChannel-struct" title="struct SpiceSmartcardChannel">SpiceSmartcardChannel</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceSmartcardChannel.html#SpiceSmartcardChannelClass" title="struct SpiceSmartcardChannelClass">SpiceSmartcardChannelClass</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceSmartcardChannel.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">╰──</span> <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> + <span class="lineart">╰──</span> SpiceSmartcardChannel +</pre> +</div> +<div class="refsect1"> +<a name="SpiceSmartcardChannel.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-client.h> +</pre> +</div> +<div class="refsect1"> +<a name="SpiceSmartcardChannel.description"></a><h2>Description</h2> +<p>The Spice protocol defines a set of messages to forward smartcard +information from the Spice client to the VM. This channel handles +these messages. While it's mainly focus on smartcard readers and +smartcards, it's also possible to use it with a software smartcard +(ie a set of 3 certificates from the client machine). +This class doesn't provide useful methods, see <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> properties +for a way to enable/disable this channel, and <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"><span class="type">SpiceSmartcardManager</span></a> +if you want to detect smartcard reader hotplug/unplug, and smartcard +insertion/removal.</p> +</div> +<div class="refsect1"> +<a name="SpiceSmartcardChannel.functions_details"></a><h2>Functions</h2> +<p></p> +</div> +<div class="refsect1"> +<a name="SpiceSmartcardChannel.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SpiceSmartcardChannel-struct"></a><h3>struct SpiceSmartcardChannel</h3> +<pre class="programlisting">struct SpiceSmartcardChannel;</pre> +<p>The <a class="link" href="SpiceSmartcardChannel.html" title="Smartcard Channel"><span class="type">SpiceSmartcardChannel</span></a> struct is opaque and should not be accessed directly.</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSmartcardChannelClass"></a><h3>struct SpiceSmartcardChannelClass</h3> +<pre class="programlisting">struct SpiceSmartcardChannelClass { + SpiceChannelClass parent_class; + + /* signals */ +}; +</pre> +<p>Class structure for <a class="link" href="SpiceSmartcardChannel.html" title="Smartcard Channel"><span class="type">SpiceSmartcardChannel</span></a>.</p> +<div class="refsect3"> +<a name="id-1.2.3.10.9.3.5"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody><tr> +<td class="struct_member_name"><p><a class="link" href="SpiceChannel.html#SpiceChannelClass" title="SpiceChannelClass"><span class="type">SpiceChannelClass</span></a> <em class="structfield"><code><a name="SpiceSmartcardChannelClass.parent-class"></a>parent_class</code></em>;</p></td> +<td class="struct_member_description"><p>Parent class.</p></td> +<td class="struct_member_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="SpiceSmartcardChannel.see-also"></a><h2>See Also</h2> +<p><a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"><span class="type">SpiceSmartcardManager</span></a>, <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a></p> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/SpiceSmartcardManager.html b/content-extra/api/spice-gtk/SpiceSmartcardManager.html new file mode 100644 index 0000000..862a6eb --- /dev/null +++ b/content-extra/api/spice-gtk/SpiceSmartcardManager.html @@ -0,0 +1,612 @@ +<!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 Smartcard Manager: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="application-support.html" title="Application Support, from spice-client-glib"> +<link rel="prev" href="SpiceAudio.html" title="Spice Audio"> +<link rel="next" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"> +<meta name="generator" content="GTK-Doc V1.24 (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="#SpiceSmartcardManager.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#SpiceSmartcardManager.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals"> <span class="dim">|</span> + <a href="#SpiceSmartcardManager.signals" class="shortcut">Signals</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="application-support.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="SpiceAudio.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="SpiceUsbDeviceManager.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="SpiceSmartcardManager"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="SpiceSmartcardManager.top_of_page"></a>Spice Smartcard Manager</span></h2> +<p>Spice Smartcard Manager — smartcard management</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="SpiceSmartcardManager.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="SpiceSmartcardManager.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"><span class="returnvalue">SpiceSmartcardManager</span></a> * +</td> +<td class="function_name"> +<a class="link" href="SpiceSmartcardManager.html#spice-smartcard-manager-get" title="spice_smartcard_manager_get ()">spice_smartcard_manager_get</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * +</td> +<td class="function_name"> +<a class="link" href="SpiceSmartcardManager.html#spice-smartcard-manager-get-readers" title="spice_smartcard_manager_get_readers ()">spice_smartcard_manager_get_readers</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceSmartcardManager.html#spice-smartcard-manager-insert-card" title="spice_smartcard_manager_insert_card ()">spice_smartcard_manager_insert_card</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceSmartcardManager.html#spice-smartcard-manager-remove-card" title="spice_smartcard_manager_remove_card ()">spice_smartcard_manager_remove_card</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceSmartcardManager.html#spice-smartcard-reader-is-software" title="spice_smartcard_reader_is_software ()">spice_smartcard_reader_is_software</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceSmartcardManager.html#spice-smartcard-reader-insert-card" title="spice_smartcard_reader_insert_card ()">spice_smartcard_reader_insert_card</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceSmartcardManager.html#spice-smartcard-reader-remove-card" title="spice_smartcard_reader_remove_card ()">spice_smartcard_reader_remove_card</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceSmartcardManager.signals"></a><h2>Signals</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="signals_return"> +<col width="300px" class="signals_name"> +<col width="200px" class="signals_flags"> +</colgroup> +<tbody> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardManager-card-inserted" title="The “card-inserted” signal">card-inserted</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardManager-card-removed" title="The “card-removed” signal">card-removed</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardManager-reader-added" title="The “reader-added” signal">reader-added</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardManager-reader-removed" title="The “reader-removed” signal">reader-removed</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceSmartcardManager.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardManager-struct" title="struct SpiceSmartcardManager">SpiceSmartcardManager</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardManagerClass" title="struct SpiceSmartcardManagerClass">SpiceSmartcardManagerClass</a></td> +</tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardReader" title="SpiceSmartcardReader">SpiceSmartcardReader</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceSmartcardManager.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">╰──</span> SpiceSmartcardManager +</pre> +</div> +<div class="refsect1"> +<a name="SpiceSmartcardManager.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-client.h> +</pre> +</div> +<div class="refsect1"> +<a name="SpiceSmartcardManager.description"></a><h2>Description</h2> +<p><a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"><span class="type">SpiceSmartcardManager</span></a> monitors smartcard reader plugging/unplugging, +and smartcard insertions/removals. It also provides methods to handle +software smartcards (to emulate a smartcard reader/smartcard on the +guest using 3 certificates available to the client).</p> +</div> +<div class="refsect1"> +<a name="SpiceSmartcardManager.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="spice-smartcard-manager-get"></a><h3>spice_smartcard_manager_get ()</h3> +<pre class="programlisting"><a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"><span class="returnvalue">SpiceSmartcardManager</span></a> * +spice_smartcard_manager_get (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p><a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"><span class="type">SpiceSmartcardManager</span></a> is a singleton, use this function to get a pointer +to it. A new SpiceSmartcardManager instance will be created the first +time this function is called</p> +<div class="refsect3"> +<a name="id-1.2.5.3.10.2.5"></a><h4>Returns</h4> +<p> a weak reference to the <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"><span class="type">SpiceSmartcardManager</span></a>. </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-smartcard-manager-get-readers"></a><h3>spice_smartcard_manager_get_readers ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * +spice_smartcard_manager_get_readers (<em class="parameter"><code><a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"><span class="type">SpiceSmartcardManager</span></a> *manager</code></em>);</pre> +<p>Gets the list of smartcard readers that are currently available, they +can be either software (emulated) readers, or hardware ones.</p> +<div class="refsect3"> +<a name="id-1.2.5.3.10.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>manager</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"><span class="type">SpiceSmartcardManager</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.5.3.10.3.6"></a><h4>Returns</h4> +<p> a newly +allocated list of SpiceSmartcardReader instances, or NULL if none were +found. When no longer needed, the list must be freed after unreferencing +its elements with <a href="/usr/share/gtk-doc/html/gobject/gobject-Boxed-Types.html#g-boxed-free"><code class="function">g_boxed_free()</code></a>. </p> +<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> SpiceSmartcardReader][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +<p class="since">Since: 0.20</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-smartcard-manager-insert-card"></a><h3>spice_smartcard_manager_insert_card ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +spice_smartcard_manager_insert_card (<em class="parameter"><code><a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"><span class="type">SpiceSmartcardManager</span></a> *manager</code></em>);</pre> +<p>Simulates the insertion of a smartcard in the guest. Valid certificates +must have been set in <a class="link" href="SpiceSession.html#SpiceSession--smartcard-certificates" title="The “smartcard-certificates” property"><span class="type">“smartcard-certificates”</span></a> for software +smartcard support to work. At the moment, only one software smartcard +reader is supported, that's why there is no parameter to indicate which +reader to insert the card in.</p> +<div class="refsect3"> +<a name="id-1.2.5.3.10.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>manager</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"><span class="type">SpiceSmartcardManager</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.5.3.10.4.6"></a><h4>Returns</h4> +<p> TRUE if smartcard insertion was successfully simulated, FALSE +if this failed, or if software smartcard support isn't enabled.</p> +</div> +<p class="since">Since: 0.20</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-smartcard-manager-remove-card"></a><h3>spice_smartcard_manager_remove_card ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +spice_smartcard_manager_remove_card (<em class="parameter"><code><a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"><span class="type">SpiceSmartcardManager</span></a> *manager</code></em>);</pre> +<p>Simulates the removal of a smartcard in the guest. At the moment, only +one software smartcard reader is supported, that's why there is no +parameter to indicate which reader to insert the card in.</p> +<div class="refsect3"> +<a name="id-1.2.5.3.10.5.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>manager</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"><span class="type">SpiceSmartcardManager</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.5.3.10.5.6"></a><h4>Returns</h4> +<p> TRUE if smartcard removal was successfully simulated, FALSE +if this failed, or if software smartcard support isn't enabled.</p> +</div> +<p class="since">Since: 0.20</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-smartcard-reader-is-software"></a><h3>spice_smartcard_reader_is_software ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +spice_smartcard_reader_is_software (<em class="parameter"><code><a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardReader" title="SpiceSmartcardReader"><span class="type">SpiceSmartcardReader</span></a> *reader</code></em>);</pre> +<p>Tests if <em class="parameter"><code>reader</code></em> + is a software (emulated) smartcard reader.</p> +<div class="refsect3"> +<a name="id-1.2.5.3.10.6.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>reader</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardReader" title="SpiceSmartcardReader"><span class="type">SpiceSmartcardReader</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.5.3.10.6.6"></a><h4>Returns</h4> +<p> TRUE if <em class="parameter"><code>reader</code></em> +is a software (emulated) smartcard reader, +FALSE otherwise</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-smartcard-reader-insert-card"></a><h3>spice_smartcard_reader_insert_card ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +spice_smartcard_reader_insert_card (<em class="parameter"><code><a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardReader" title="SpiceSmartcardReader"><span class="type">SpiceSmartcardReader</span></a> *reader</code></em>);</pre> +<p>Simulates insertion of a smartcard in the software smartcard reader +<em class="parameter"><code>reader</code></em> +. If <em class="parameter"><code>reader</code></em> + is not a software smartcard reader, FALSE will be +returned.</p> +<div class="refsect3"> +<a name="id-1.2.5.3.10.7.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>reader</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardReader" title="SpiceSmartcardReader"><span class="type">SpiceSmartcardReader</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.5.3.10.7.6"></a><h4>Returns</h4> +<p> TRUE if insertion of a card was successfully simulated, FALSE +otherwise</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-smartcard-reader-remove-card"></a><h3>spice_smartcard_reader_remove_card ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +spice_smartcard_reader_remove_card (<em class="parameter"><code><a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardReader" title="SpiceSmartcardReader"><span class="type">SpiceSmartcardReader</span></a> *reader</code></em>);</pre> +<p>Simulates removal of a smartcard from the software smartcard reader +<em class="parameter"><code>reader</code></em> +. If <em class="parameter"><code>reader</code></em> + is not a software smartcard reader, FALSE will be +returned.</p> +<div class="refsect3"> +<a name="id-1.2.5.3.10.8.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>reader</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardReader" title="SpiceSmartcardReader"><span class="type">SpiceSmartcardReader</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.5.3.10.8.6"></a><h4>Returns</h4> +<p> TRUE if removal of a card was successfully simulated, FALSE +otherwise</p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="SpiceSmartcardManager.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SpiceSmartcardManager-struct"></a><h3>struct SpiceSmartcardManager</h3> +<pre class="programlisting">struct SpiceSmartcardManager;</pre> +<p>The <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"><span class="type">SpiceSmartcardManager</span></a> struct is opaque and should not be accessed directly.</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSmartcardManagerClass"></a><h3>struct SpiceSmartcardManagerClass</h3> +<pre class="programlisting">struct SpiceSmartcardManagerClass { + GObjectClass parent_class; + /* signals */ + void (*reader_added)(SpiceSmartcardManager *manager, SpiceSmartcardReader *reader); + void (*reader_removed)(SpiceSmartcardManager *manager, SpiceSmartcardReader *reader); + void (*card_inserted)(SpiceSmartcardManager *manager, SpiceSmartcardReader *reader); + void (*card_removed)(SpiceSmartcardManager *manager, SpiceSmartcardReader *reader ); +}; +</pre> +<p>Class structure for <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"><span class="type">SpiceSmartcardManager</span></a>.</p> +<div class="refsect3"> +<a name="id-1.2.5.3.11.3.5"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="SpiceSmartcardManagerClass.parent-class"></a>parent_class</code></em>;</p></td> +<td class="struct_member_description"><p>Parent class.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceSmartcardManagerClass.reader-added"></a>reader_added</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardManager-reader-added" title="The “reader-added” signal"><span class="type">“reader_added”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceSmartcardManagerClass.reader-removed"></a>reader_removed</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardManager-reader-removed" title="The “reader-removed” signal"><span class="type">“reader_removed”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceSmartcardManagerClass.card-inserted"></a>card_inserted</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardManager-card-inserted" title="The “card-inserted” signal"><span class="type">“card_inserted”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceSmartcardManagerClass.card-removed"></a>card_removed</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardManager-card-removed" title="The “card-removed” signal"><span class="type">“card_removed”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSmartcardReader"></a><h3>SpiceSmartcardReader</h3> +<pre class="programlisting">typedef struct _SpiceSmartcardReader SpiceSmartcardReader;</pre> +<p>The <a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardReader" title="SpiceSmartcardReader"><span class="type">SpiceSmartcardReader</span></a> struct is opaque and cannot be accessed directly.</p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceSmartcardManager.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="SpiceSmartcardManager-card-inserted"></a><h3>The <code class="literal">“card-inserted”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"><span class="type">SpiceSmartcardManager</span></a> *manager, + <span class="type">VReader</span> *vreader, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardManager-card-inserted" title="The “card-inserted” signal"><span class="type">“card-inserted”</span></a> signal is emitted whenever +a smartcard is inserted in a reader</p> +<div class="refsect3"> +<a name="id-1.2.5.3.12.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>manager</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"><span class="type">SpiceSmartcardManager</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>vreader</p></td> +<td class="parameter_description"><p><span class="type">VReader</span> boxed object corresponding to the reader a new +card was inserted in</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSmartcardManager-card-removed"></a><h3>The <code class="literal">“card-removed”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"><span class="type">SpiceSmartcardManager</span></a> *manager, + <span class="type">VReader</span> *vreader, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardManager-card-removed" title="The “card-removed” signal"><span class="type">“card-removed”</span></a> signal is emitted whenever +a smartcard was removed from a reader.</p> +<div class="refsect3"> +<a name="id-1.2.5.3.12.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>manager</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"><span class="type">SpiceSmartcardManager</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>vreader</p></td> +<td class="parameter_description"><p><span class="type">VReader</span> boxed object corresponding to the reader a card +was removed from</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSmartcardManager-reader-added"></a><h3>The <code class="literal">“reader-added”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"><span class="type">SpiceSmartcardManager</span></a> *manager, + <span class="type">VReader</span> *vreader, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardManager-reader-added" title="The “reader-added” signal"><span class="type">“reader-added”</span></a> signal is emitted whenever +a new smartcard reader (software or hardware) has been plugged in.</p> +<div class="refsect3"> +<a name="id-1.2.5.3.12.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>manager</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"><span class="type">SpiceSmartcardManager</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>vreader</p></td> +<td class="parameter_description"><p><span class="type">VReader</span> boxed object corresponding to the added reader</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceSmartcardManager-reader-removed"></a><h3>The <code class="literal">“reader-removed”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"><span class="type">SpiceSmartcardManager</span></a> *manager, + <span class="type">VReader</span> *vreader, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardManager-reader-removed" title="The “reader-removed” signal"><span class="type">“reader-removed”</span></a> signal is emitted whenever +a smartcard reader (software or hardware) has been removed.</p> +<div class="refsect3"> +<a name="id-1.2.5.3.12.5.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>manager</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"><span class="type">SpiceSmartcardManager</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>vreader</p></td> +<td class="parameter_description"><p><span class="type">VReader</span> boxed object corresponding to the removed reader</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/SpiceUsbDeviceManager.html b/content-extra/api/spice-gtk/SpiceUsbDeviceManager.html new file mode 100644 index 0000000..515d370 --- /dev/null +++ b/content-extra/api/spice-gtk/SpiceUsbDeviceManager.html @@ -0,0 +1,961 @@ +<!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 Manager: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="application-support.html" title="Application Support, from spice-client-glib"> +<link rel="prev" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager"> +<link rel="next" href="spice-gtk-Utilities.html" title="Utilities"> +<meta name="generator" content="GTK-Doc V1.24 (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="#SpiceUsbDeviceManager.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#SpiceUsbDeviceManager.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> + <a href="#SpiceUsbDeviceManager.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#SpiceUsbDeviceManager.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> + <a href="#SpiceUsbDeviceManager.signals" class="shortcut">Signals</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="application-support.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="SpiceSmartcardManager.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="spice-gtk-Utilities.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="SpiceUsbDeviceManager"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="SpiceUsbDeviceManager.top_of_page"></a>Spice USB Manager</span></h2> +<p>Spice USB Manager — USB device management</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="SpiceUsbDeviceManager.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="SpiceUsbDeviceManager.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="returnvalue">SpiceUsbDeviceManager</span></a> * +</td> +<td class="function_name"> +<a class="link" href="SpiceUsbDeviceManager.html#spice-usb-device-manager-get" title="spice_usb_device_manager_get ()">spice_usb_device_manager_get</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * +</td> +<td class="function_name"> +<a class="link" href="SpiceUsbDeviceManager.html#spice-usb-device-manager-get-devices" title="spice_usb_device_manager_get_devices ()">spice_usb_device_manager_get_devices</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * +</td> +<td class="function_name"> +<a class="link" href="SpiceUsbDeviceManager.html#spice-usb-device-manager-get-devices-with-filter" title="spice_usb_device_manager_get_devices_with_filter ()">spice_usb_device_manager_get_devices_with_filter</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceUsbDeviceManager.html#spice-usb-device-manager-is-device-connected" title="spice_usb_device_manager_is_device_connected ()">spice_usb_device_manager_is_device_connected</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="SpiceUsbDeviceManager.html#spice-usb-device-manager-disconnect-device" title="spice_usb_device_manager_disconnect_device ()">spice_usb_device_manager_disconnect_device</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceUsbDeviceManager.html#spice-usb-device-manager-can-redirect-device" title="spice_usb_device_manager_can_redirect_device ()">spice_usb_device_manager_can_redirect_device</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="SpiceUsbDeviceManager.html#spice-usb-device-manager-connect-device-async" title="spice_usb_device_manager_connect_device_async ()">spice_usb_device_manager_connect_device_async</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceUsbDeviceManager.html#spice-usb-device-manager-connect-device-finish" title="spice_usb_device_manager_connect_device_finish ()">spice_usb_device_manager_connect_device_finish</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +</td> +<td class="function_name"> +<a class="link" href="SpiceUsbDeviceManager.html#spice-usb-device-get-description" title="spice_usb_device_get_description ()">spice_usb_device_get_description</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"><span class="returnvalue">gconstpointer</span></a> +</td> +<td class="function_name"> +<a class="link" href="SpiceUsbDeviceManager.html#spice-usb-device-get-libusb-device" title="spice_usb_device_get_libusb_device ()">spice_usb_device_get_libusb_device</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceUsbDeviceManager.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager--auto-connect" title="The “auto-connect” property">auto-connect</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager--auto-connect-filter" title="The “auto-connect-filter” property">auto-connect-filter</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager--redirect-on-connect" title="The “redirect-on-connect” property">redirect-on-connect</a></td> +<td class="property_flags">Read / Write</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="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager--session" title="The “session” property">session</a></td> +<td class="property_flags">Read / Write / Construct Only</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceUsbDeviceManager.signals"></a><h2>Signals</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="signals_return"> +<col width="300px" class="signals_name"> +<col width="200px" class="signals_flags"> +</colgroup> +<tbody> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-auto-connect-failed" title="The “auto-connect-failed” signal">auto-connect-failed</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-device-added" title="The “device-added” signal">device-added</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-device-error" title="The “device-error” signal">device-error</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-device-removed" title="The “device-removed” signal">device-removed</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +</tbody> +</table></div> +</div> +<a name="SpiceUsbDevice"></a><div class="refsect1"> +<a name="SpiceUsbDeviceManager.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-struct" title="struct SpiceUsbDeviceManager">SpiceUsbDeviceManager</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManagerClass" title="struct SpiceUsbDeviceManagerClass">SpiceUsbDeviceManagerClass</a></td> +</tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice-struct" title="SpiceUsbDevice">SpiceUsbDevice</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceUsbDeviceManager.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> SpiceUsbDevice + <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">╰──</span> SpiceUsbDeviceManager +</pre> +</div> +<div class="refsect1"> +<a name="SpiceUsbDeviceManager.implemented-interfaces"></a><h2>Implemented Interfaces</h2> +<p> +SpiceUsbDeviceManager implements + <a href="/usr/share/gtk-doc/html/gio/GInitable.html">GInitable</a>.</p> +</div> +<div class="refsect1"> +<a name="SpiceUsbDeviceManager.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-client.h> +</pre> +</div> +<div class="refsect1"> +<a name="SpiceUsbDeviceManager.description"></a><h2>Description</h2> +<p><a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> monitors USB redirection channels and USB +devices plugging/unplugging. If <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager--auto-connect" title="The “auto-connect” property"><span class="type">“auto-connect”</span></a> +is set to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, it will automatically connect newly plugged USB +devices to available channels.</p> +<p>There should always be a 1:1 relation between <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> objects +and <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> objects. Therefor there is no +spice_usb_device_manager_new, instead there is +<a class="link" href="SpiceUsbDeviceManager.html#spice-usb-device-manager-get" title="spice_usb_device_manager_get ()"><code class="function">spice_usb_device_manager_get()</code></a> which ensures this 1:1 relation.</p> +</div> +<div class="refsect1"> +<a name="SpiceUsbDeviceManager.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="spice-usb-device-manager-get"></a><h3>spice_usb_device_manager_get ()</h3> +<pre class="programlisting"><a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="returnvalue">SpiceUsbDeviceManager</span></a> * +spice_usb_device_manager_get (<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/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre> +<p>Gets the <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> associated with the passed in <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a>. +A new <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> 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="id-1.2.5.4.13.2.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>err</p></td> +<td class="parameter_description"><p> a return location for <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</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="id-1.2.5.4.13.2.7"></a><h4>Returns</h4> +<p> a weak reference to the <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> associated with the passed in <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a>. </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-usb-device-manager-get-devices"></a><h3>spice_usb_device_manager_get_devices ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * +spice_usb_device_manager_get_devices (<em class="parameter"><code><a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> *manager</code></em>);</pre> +<p>Finds devices associated with the <em class="parameter"><code>manager</code></em> +</p> +<div class="refsect3"> +<a name="id-1.2.5.4.13.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>manager</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> manager</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.5.4.13.3.6"></a><h4>Returns</h4> +<p> a <a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><code class="literal">GPtrArray</code></a> array of <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><code class="literal">SpiceUsbDevice</code></a>. </p> +<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> SpiceUsbDevice][<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-usb-device-manager-get-devices-with-filter"></a><h3>spice_usb_device_manager_get_devices_with_filter ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * +spice_usb_device_manager_get_devices_with_filter + (<em class="parameter"><code><a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> *manager</code></em>, + <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filter</code></em>);</pre> +<p>Finds devices associated with the <em class="parameter"><code>manager</code></em> + complying with the <em class="parameter"><code>filter</code></em> +</p> +<div class="refsect3"> +<a name="id-1.2.5.4.13.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>manager</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> manager</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>filter</p></td> +<td class="parameter_description"><p> filter string for selecting which devices to return, +see <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager--auto-connect-filter" title="The “auto-connect-filter” property"><span class="type">“auto-connect-filter”</span></a> for the filter +string format. </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="id-1.2.5.4.13.4.6"></a><h4>Returns</h4> +<p> a +<a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><code class="literal">GPtrArray</code></a> array of <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><code class="literal">SpiceUsbDevice</code></a>. </p> +<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> SpiceUsbDevice][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +<p class="since">Since: 0.20</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-usb-device-manager-is-device-connected"></a><h3>spice_usb_device_manager_is_device_connected ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +spice_usb_device_manager_is_device_connected + (<em class="parameter"><code><a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> *manager</code></em>, + <em class="parameter"><code><a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><span class="type">SpiceUsbDevice</span></a> *device</code></em>);</pre> +<p>Finds if the <em class="parameter"><code>device</code></em> + is connected.</p> +<div class="refsect3"> +<a name="id-1.2.5.4.13.5.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>manager</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> manager</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>device</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><span class="type">SpiceUsbDevice</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.5.4.13.5.6"></a><h4>Returns</h4> +<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>device</code></em> +has an associated USB redirection channel</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-usb-device-manager-disconnect-device"></a><h3>spice_usb_device_manager_disconnect_device ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_usb_device_manager_disconnect_device + (<em class="parameter"><code><a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> *manager</code></em>, + <em class="parameter"><code><a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><span class="type">SpiceUsbDevice</span></a> *device</code></em>);</pre> +<p>Disconnects the <em class="parameter"><code>device</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.2.5.4.13.6.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>manager</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> manager</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>device</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><span class="type">SpiceUsbDevice</span></a> to disconnect</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.5.4.13.6.6"></a><h4>Returns</h4> +<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>device</code></em> +has an associated USB redirection channel</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-usb-device-manager-can-redirect-device"></a><h3>spice_usb_device_manager_can_redirect_device ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +spice_usb_device_manager_can_redirect_device + (<em class="parameter"><code><a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> *self</code></em>, + <em class="parameter"><code><a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><span class="type">SpiceUsbDevice</span></a> *device</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre> +<p>Checks whether it is possible to redirect the <em class="parameter"><code>device</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.2.5.4.13.7.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>the <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> manager</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>device</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><span class="type">SpiceUsbDevice</span></a> to disconnect</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>err</p></td> +<td class="parameter_description"><p> a return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</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="id-1.2.5.4.13.7.6"></a><h4>Returns</h4> +<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>device</code></em> +can be redirected</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-usb-device-manager-connect-device-async"></a><h3>spice_usb_device_manager_connect_device_async ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_usb_device_manager_connect_device_async + (<em class="parameter"><code><a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> *self</code></em>, + <em class="parameter"><code><a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><span class="type">SpiceUsbDevice</span></a> *device</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> +<p>Asynchronously connects the <em class="parameter"><code>device</code></em> +. When completed, <em class="parameter"><code>callback</code></em> + will be called. +Then it is possible to call <a class="link" href="SpiceUsbDeviceManager.html#spice-usb-device-manager-connect-device-finish" title="spice_usb_device_manager_connect_device_finish ()"><code class="function">spice_usb_device_manager_connect_device_finish()</code></a> +to get the result of the operation.</p> +<div class="refsect3"> +<a name="id-1.2.5.4.13.8.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>device</p></td> +<td class="parameter_description"><p>a <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><span class="type">SpiceUsbDevice</span></a> to redirect</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> optional <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </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> +<tr> +<td class="parameter_name"><p>callback</p></td> +<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when the request is satisfied</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>the data to pass to callback function</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-usb-device-manager-connect-device-finish"></a><h3>spice_usb_device_manager_connect_device_finish ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +spice_usb_device_manager_connect_device_finish + (<em class="parameter"><code><a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> *self</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *res</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre> +<p>Finishes an async operation. See <a class="link" href="SpiceUsbDeviceManager.html#spice-usb-device-manager-connect-device-async" title="spice_usb_device_manager_connect_device_async ()"><code class="function">spice_usb_device_manager_connect_device_async()</code></a>.</p> +<div class="refsect3"> +<a name="id-1.2.5.4.13.9.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>res</p></td> +<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>err</p></td> +<td class="parameter_description"><p> a return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</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="id-1.2.5.4.13.9.6"></a><h4>Returns</h4> +<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if connection is successful</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-usb-device-get-description"></a><h3>spice_usb_device_get_description ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +spice_usb_device_get_description (<em class="parameter"><code><a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><span class="type">SpiceUsbDevice</span></a> *device</code></em>, + <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>);</pre> +<p>Get a string describing the device which is suitable as a description of +the device for the end user. The returned string should be freed with +<a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no longer needed.</p> +<p>The <em class="parameter"><code>format</code></em> + positional parameters are the following:</p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p>'%<code class="literal">1</code>$s' manufacturer</p></li> +<li class="listitem"><p>'%<code class="literal">2</code>$s' product</p></li> +<li class="listitem"><p>'%<code class="literal">3</code>$s' descriptor (a [vendor_id:product_id] string)</p></li> +<li class="listitem"><p>'%<code class="literal">4</code>$d' bus</p></li> +<li class="listitem"><p>'%<code class="literal">5</code>$d' address</p></li> +</ul></div> +<p>(the default format string is "%<code class="literal">s</code> %<code class="literal">s</code> %<code class="literal">s</code> at %<code class="literal">d</code>-%<code class="literal">d</code>")</p> +<div class="refsect3"> +<a name="id-1.2.5.4.13.10.8"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>device</p></td> +<td class="parameter_description"><p><a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><span class="type">SpiceUsbDevice</span></a> to get the description of</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>format</p></td> +<td class="parameter_description"><p> an optional <code class="function">printf()</code> format string with +positional parameters. </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="id-1.2.5.4.13.10.9"></a><h4>Returns</h4> +<p> a newly-allocated string holding the description, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if failed</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-usb-device-get-libusb-device"></a><h3>spice_usb_device_get_libusb_device ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"><span class="returnvalue">gconstpointer</span></a> +spice_usb_device_get_libusb_device (<em class="parameter"><code>const <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><span class="type">SpiceUsbDevice</span></a> *device</code></em>);</pre> +<p>Finds the <code class="literal">libusb_device</code> associated with the <em class="parameter"><code>device</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.2.5.4.13.11.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>device</p></td> +<td class="parameter_description"><p><a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><span class="type">SpiceUsbDevice</span></a> to get the descriptor information of</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.5.4.13.11.6"></a><h4>Returns</h4> +<p> the <code class="literal">libusb_device</code> associated to <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><code class="literal">SpiceUsbDevice</code></a>. </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> +<p class="since">Since: 0.27</p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceUsbDeviceManager.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SpiceUsbDeviceManager-struct"></a><h3>struct SpiceUsbDeviceManager</h3> +<pre class="programlisting">struct SpiceUsbDeviceManager;</pre> +<p>The <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> struct is opaque and should not be accessed directly.</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceUsbDeviceManagerClass"></a><h3>struct SpiceUsbDeviceManagerClass</h3> +<pre class="programlisting">struct SpiceUsbDeviceManagerClass { + GObjectClass parent_class; + + /* signals */ + void (*device_added) (SpiceUsbDeviceManager *manager, + SpiceUsbDevice *device); + void (*device_removed) (SpiceUsbDeviceManager *manager, + SpiceUsbDevice *device); + void (*auto_connect_failed) (SpiceUsbDeviceManager *manager, + SpiceUsbDevice *device, GError *error); + void (*device_error) (SpiceUsbDeviceManager *manager, + SpiceUsbDevice *device, GError *error); +}; +</pre> +<p>Class structure for <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a>.</p> +<div class="refsect3"> +<a name="id-1.2.5.4.14.3.5"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="SpiceUsbDeviceManagerClass.parent-class"></a>parent_class</code></em>;</p></td> +<td class="struct_member_description"><p>Parent class.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceUsbDeviceManagerClass.device-added"></a>device_added</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-device-added" title="The “device-added” signal"><span class="type">“device-added”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceUsbDeviceManagerClass.device-removed"></a>device_removed</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-device-removed" title="The “device-removed” signal"><span class="type">“device-removed”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceUsbDeviceManagerClass.auto-connect-failed"></a>auto_connect_failed</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-auto-connect-failed" title="The “auto-connect-failed” signal"><span class="type">“auto-connect-failed”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceUsbDeviceManagerClass.device-error"></a>device_error</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-device-error" title="The “device-error” signal"><span class="type">“device_error”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceUsbDevice-struct"></a><h3>SpiceUsbDevice</h3> +<pre class="programlisting">typedef struct _SpiceUsbDevice SpiceUsbDevice;</pre> +<p>The <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><span class="type">SpiceUsbDevice</span></a> struct is opaque and cannot be accessed directly.</p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceUsbDeviceManager.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="SpiceUsbDeviceManager--auto-connect"></a><h3>The <code class="literal">“auto-connect”</code> property</h3> +<pre class="programlisting"> “auto-connect” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Set this to TRUE to automatically redirect newly plugged in device.</p> +<p>Note when <a class="link" href="SpiceGtkSession.html" title="Spice GTK Session"><span class="type">SpiceGtkSession</span></a>'s auto-usbredir property is TRUE, this +property is controlled by <a class="link" href="SpiceGtkSession.html" title="Spice GTK Session"><span class="type">SpiceGtkSession</span></a>.</p> +<p>Flags: Read / Write</p> +<p>Default value: FALSE</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceUsbDeviceManager--auto-connect-filter"></a><h3>The <code class="literal">“auto-connect-filter”</code> property</h3> +<pre class="programlisting"> “auto-connect-filter” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>Set a string specifying a filter to use to determine which USB devices +to autoconnect when plugged in, a filter consists of one or more rules. +Where each rule has the form of:</p> +<p><em class="parameter"><code>class</code></em> +,<em class="parameter"><code>vendor</code></em> +,<em class="parameter"><code>product</code></em> +,<em class="parameter"><code>version</code></em> +,<em class="parameter"><code>allow</code></em> +</p> +<p>Use -1 for <em class="parameter"><code>class</code></em> +/<em class="parameter"><code>vendor</code></em> +/<em class="parameter"><code>product</code></em> +/<em class="parameter"><code>version</code></em> + to accept any value.</p> +<p>And the rules themselves are concatenated like this:</p> +<p><em class="parameter"><code>rule1</code></em> +|<em class="parameter"><code>rule2</code></em> +|<em class="parameter"><code>rule3</code></em> +</p> +<p>The default setting filters out HID (class 0x03) USB devices from auto +connect and auto connects anything else. Note the explicit allow rule at +the end, this is necessary since by default all devices without a +matching filter rule will not auto-connect.</p> +<p>Filter strings in this format can be easily created with the RHEV-M +USB filter editor tool.</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: "0x03,-1,-1,-1,0|-1,-1,-1,-1,1"</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceUsbDeviceManager--redirect-on-connect"></a><h3>The <code class="literal">“redirect-on-connect”</code> property</h3> +<pre class="programlisting"> “redirect-on-connect” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>Set a string specifying a filter selecting USB devices to automatically +redirect after a Spice connection has been established.</p> +<p>See <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager--auto-connect-filter" title="The “auto-connect-filter” property"><span class="type">“auto-connect-filter”</span></a> for the filter string +format.</p> +<p>Flags: Read / Write</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceUsbDeviceManager--session"></a><h3>The <code class="literal">“session”</code> property</h3> +<pre class="programlisting"> “session” <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> *</pre> +<p><a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> this <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> is associated with</p> +<p>Flags: Read / Write / Construct Only</p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceUsbDeviceManager.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="SpiceUsbDeviceManager-auto-connect-failed"></a><h3>The <code class="literal">“auto-connect-failed”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> *manager, + <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><span class="type">SpiceUsbDevice</span></a> *device, + <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-auto-connect-failed" title="The “auto-connect-failed” signal"><span class="type">“auto-connect-failed”</span></a> signal is emitted +whenever the auto-connect property is true, and a newly plugged in +device could not be auto-connected.</p> +<div class="refsect3"> +<a name="id-1.2.5.4.16.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>manager</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>device</p></td> +<td class="parameter_description"><p><a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><span class="type">SpiceUsbDevice</span></a> boxed object corresponding to the device which failed to auto connect</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> describing the reason why the autoconnect failed</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceUsbDeviceManager-device-added"></a><h3>The <code class="literal">“device-added”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> *manager, + <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><span class="type">SpiceUsbDevice</span></a> *device, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-device-added" title="The “device-added” signal"><span class="type">“device-added”</span></a> signal is emitted whenever +a new USB device has been plugged in.</p> +<div class="refsect3"> +<a name="id-1.2.5.4.16.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>manager</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>device</p></td> +<td class="parameter_description"><p><a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><span class="type">SpiceUsbDevice</span></a> boxed object corresponding to the added device</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceUsbDeviceManager-device-error"></a><h3>The <code class="literal">“device-error”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> *manager, + <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><span class="type">SpiceUsbDevice</span></a> *device, + <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-device-error" title="The “device-error” signal"><span class="type">“device-error”</span></a> signal is emitted whenever an +error happens which causes a device to no longer be available to the +guest.</p> +<div class="refsect3"> +<a name="id-1.2.5.4.16.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>manager</p></td> +<td class="parameter_description"><p><a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>device</p></td> +<td class="parameter_description"><p><a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><span class="type">SpiceUsbDevice</span></a> boxed object corresponding to the device which has an error</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> describing the error</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceUsbDeviceManager-device-removed"></a><h3>The <code class="literal">“device-removed”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> *manager, + <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><span class="type">SpiceUsbDevice</span></a> *device, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-device-removed" title="The “device-removed” signal"><span class="type">“device-removed”</span></a> signal is emitted whenever +an USB device has been removed.</p> +<div class="refsect3"> +<a name="id-1.2.5.4.16.5.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>manager</p></td> +<td class="parameter_description"><p>the <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"><span class="type">SpiceUsbDeviceManager</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>device</p></td> +<td class="parameter_description"><p><a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><span class="type">SpiceUsbDevice</span></a> boxed object corresponding to the removed device</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/SpiceUsbDeviceWidget.html b/content-extra/api/spice-gtk/SpiceUsbDeviceWidget.html new file mode 100644 index 0000000..9d2b708 --- /dev/null +++ b/content-extra/api/spice-gtk/SpiceUsbDeviceWidget.html @@ -0,0 +1,298 @@ +<!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.78.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="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.24 (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="#SpiceUsbDeviceWidget.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#SpiceUsbDeviceWidget.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> + <a href="#SpiceUsbDeviceWidget.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#SpiceUsbDeviceWidget.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> + <a href="#SpiceUsbDeviceWidget.signals" class="shortcut">Signals</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="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="SpiceUsbDeviceWidget"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="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="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="SpiceUsbDeviceWidget.functions"></a><h2>Functions</h2> +<div class="informaltable"><table 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/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * +</td> +<td class="function_name"> +<a class="link" href="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="SpiceUsbDeviceWidget.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget--device-format-string" title="The “device-format-string” property">device-format-string</a></td> +<td class="property_flags">Read / Write / Construct Only</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="SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget--session" title="The “session” property">session</a></td> +<td class="property_flags">Read / Write / Construct Only</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceUsbDeviceWidget.signals"></a><h2>Signals</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="signals_return"> +<col width="300px" class="signals_name"> +<col width="200px" class="signals_flags"> +</colgroup> +<tbody><tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget-connect-failed" title="The “connect-failed” signal">connect-failed</a></td> +<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceUsbDeviceWidget.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget-struct" title="struct SpiceUsbDeviceWidget">SpiceUsbDeviceWidget</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidgetClass" title="struct SpiceUsbDeviceWidgetClass">SpiceUsbDeviceWidgetClass</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceUsbDeviceWidget.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> + <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk2/GtkWidget.html">GtkWidget</a> + <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk2/GtkContainer.html">GtkContainer</a> + <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk2/GtkBox.html">GtkBox</a> + <span class="lineart">╰──</span> SpiceUsbDeviceWidget +</pre> +</div> +<div class="refsect1"> +<a name="SpiceUsbDeviceWidget.implemented-interfaces"></a><h2>Implemented Interfaces</h2> +<p> +SpiceUsbDeviceWidget implements + AtkImplementorIface, <a href="/usr/share/gtk-doc/html/gtk2/GtkBuildable.html">GtkBuildable</a> and <a href="/usr/share/gtk-doc/html/gtk2/gtk2-Orientable.html#GtkOrientable">GtkOrientable</a>.</p> +</div> +<div class="refsect1"> +<a name="SpiceUsbDeviceWidget.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-client-gtk.h> +</pre> +</div> +<div class="refsect1"> +<a name="SpiceUsbDeviceWidget.description"></a><h2>Description</h2> +<p><a class="link" href="SpiceUsbDeviceWidget.html" title="Spice USB device selection widget"><span class="type">SpiceUsbDeviceWidget</span></a> 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="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/gtk2/GtkWidget.html"><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/glib/glib-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="id-1.2.4.4.12.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="id-1.2.4.4.12.2.6"></a><h4>Returns</h4> +<p> a new <a class="link" href="SpiceUsbDeviceWidget.html" title="Spice USB device selection widget"><span class="type">SpiceUsbDeviceWidget</span></a> instance</p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="SpiceUsbDeviceWidget.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SpiceUsbDeviceWidget-struct"></a><h3>struct SpiceUsbDeviceWidget</h3> +<pre class="programlisting">struct SpiceUsbDeviceWidget;</pre> +<p>The <a class="link" href="SpiceUsbDeviceWidget.html" title="Spice USB device selection widget"><span class="type">SpiceUsbDeviceWidget</span></a> struct is opaque and should not be accessed directly.</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceUsbDeviceWidgetClass"></a><h3>struct SpiceUsbDeviceWidgetClass</h3> +<pre class="programlisting">struct SpiceUsbDeviceWidgetClass { + GtkVBoxClass parent_class; + + /* signals */ + void (*connect_failed) (SpiceUsbDeviceWidget *widget, + SpiceUsbDevice *device, GError *error); +}; +</pre> +<p>Class structure for <a class="link" href="SpiceUsbDeviceWidget.html" title="Spice USB device selection widget"><span class="type">SpiceUsbDeviceWidget</span></a>.</p> +<div class="refsect3"> +<a name="id-1.2.4.4.13.3.5"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="struct_member_name"><p><span class="type">GtkVBoxClass</span> <em class="structfield"><code><a name="SpiceUsbDeviceWidgetClass.parent-class"></a>parent_class</code></em>;</p></td> +<td class="struct_member_description"><p>Parent class.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><em class="structfield"><code><a name="SpiceUsbDeviceWidgetClass.connect-failed"></a>connect_failed</code></em> ()</p></td> +<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget-connect-failed" title="The “connect-failed” signal"><span class="type">“connect-failed”</span></a> signal.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="SpiceUsbDeviceWidget.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="SpiceUsbDeviceWidget--device-format-string"></a><h3>The <code class="literal">“device-format-string”</code> property</h3> +<pre class="programlisting"> “device-format-string” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>Format string to pass 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> for getting +the device USB descriptions.</p> +<p>Flags: Read / Write / Construct Only</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceUsbDeviceWidget--session"></a><h3>The <code class="literal">“session”</code> property</h3> +<pre class="programlisting"> “session” <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> *</pre> +<p><a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> this <a class="link" href="SpiceUsbDeviceWidget.html" title="Spice USB device selection widget"><span class="type">SpiceUsbDeviceWidget</span></a> is associated with</p> +<p>Flags: Read / Write / Construct Only</p> +</div> +</div> +<div class="refsect1"> +<a name="SpiceUsbDeviceWidget.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="SpiceUsbDeviceWidget-connect-failed"></a><h3>The <code class="literal">“connect-failed”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="SpiceUsbDeviceWidget.html" title="Spice USB device selection widget"><span class="type">SpiceUsbDeviceWidget</span></a> *widget, + <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><span class="type">SpiceUsbDevice</span></a> *device, + <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>The <a class="link" href="SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget-connect-failed" title="The “connect-failed” signal"><span class="type">“connect-failed”</span></a> signal is emitted whenever +the user has requested for a device to be redirected and this has +failed.</p> +<div class="refsect3"> +<a name="id-1.2.4.4.15.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>widget</p></td> +<td class="parameter_description"><p>The <a class="link" href="SpiceUsbDeviceWidget.html" title="Spice USB device selection widget"><span class="type">SpiceUsbDeviceWidget</span></a> that emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>device</p></td> +<td class="parameter_description"><p><a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice"><span class="type">SpiceUsbDevice</span></a> boxed object corresponding to the added device</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> describing the reason why the connect failed</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/SpiceUsbredirChannel.html b/content-extra/api/spice-gtk/SpiceUsbredirChannel.html new file mode 100644 index 0000000..0464d80 --- /dev/null +++ b/content-extra/api/spice-gtk/SpiceUsbredirChannel.html @@ -0,0 +1,117 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>USB Redirection Channel: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="ch02.html" title="Session and Channels Objects, from spice-client-glib"> +<link rel="prev" href="SpiceSmartcardChannel.html" title="Smartcard Channel"> +<link rel="next" href="SpicePortChannel.html" title="Port Channel"> +<meta name="generator" content="GTK-Doc V1.24 (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="#SpiceUsbredirChannel.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#SpiceUsbredirChannel.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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="SpiceSmartcardChannel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="SpicePortChannel.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="SpiceUsbredirChannel"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="SpiceUsbredirChannel.top_of_page"></a>USB Redirection Channel</span></h2> +<p>USB Redirection Channel — usb redirection</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="SpiceUsbredirChannel.stability-level"></a><h2>Stability Level</h2> +<a href="http://foldoc.org/API%20Stable%20(channel%20in%20development)"><span class="acronym">API Stable (channel in development)</span></a>, unless otherwise indicated +</div> +<div class="refsect1"> +<a name="SpiceUsbredirChannel.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceUsbredirChannel.html#SpiceUsbredirChannel-struct" title="struct SpiceUsbredirChannel">SpiceUsbredirChannel</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceUsbredirChannel.html#SpiceUsbredirChannelClass" title="struct SpiceUsbredirChannelClass">SpiceUsbredirChannelClass</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceUsbredirChannel.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">╰──</span> <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> + <span class="lineart">╰──</span> SpiceUsbredirChannel +</pre> +</div> +<div class="refsect1"> +<a name="SpiceUsbredirChannel.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-client.h> +</pre> +</div> +<div class="refsect1"> +<a name="SpiceUsbredirChannel.description"></a><h2>Description</h2> +<p>The Spice protocol defines a set of messages to redirect USB devices +from the Spice client to the VM. This channel handles these messages.</p> +</div> +<div class="refsect1"> +<a name="SpiceUsbredirChannel.functions_details"></a><h2>Functions</h2> +<p></p> +</div> +<div class="refsect1"> +<a name="SpiceUsbredirChannel.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SpiceUsbredirChannel-struct"></a><h3>struct SpiceUsbredirChannel</h3> +<pre class="programlisting">struct SpiceUsbredirChannel;</pre> +<p>The <a class="link" href="SpiceUsbredirChannel.html" title="USB Redirection Channel"><span class="type">SpiceUsbredirChannel</span></a> struct is opaque and should not be accessed directly.</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceUsbredirChannelClass"></a><h3>struct SpiceUsbredirChannelClass</h3> +<pre class="programlisting">struct SpiceUsbredirChannelClass { + SpiceChannelClass parent_class; + + /* signals */ +}; +</pre> +<p>Class structure for <a class="link" href="SpiceUsbredirChannel.html" title="USB Redirection Channel"><span class="type">SpiceUsbredirChannel</span></a>.</p> +<div class="refsect3"> +<a name="id-1.2.3.11.9.3.5"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody><tr> +<td class="struct_member_name"><p><a class="link" href="SpiceChannel.html#SpiceChannelClass" title="SpiceChannelClass"><span class="type">SpiceChannelClass</span></a> <em class="structfield"><code><a name="SpiceUsbredirChannelClass.parent-class"></a>parent_class</code></em>;</p></td> +<td class="struct_member_description"><p>Parent class.</p></td> +<td class="struct_member_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/SpiceWebdavChannel.html b/content-extra/api/spice-gtk/SpiceWebdavChannel.html new file mode 100644 index 0000000..255268e --- /dev/null +++ b/content-extra/api/spice-gtk/SpiceWebdavChannel.html @@ -0,0 +1,130 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>WebDAV Channel: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="ch02.html" title="Session and Channels Objects, from spice-client-glib"> +<link rel="prev" href="SpicePortChannel.html" title="Port Channel"> +<link rel="next" href="ch03.html" title="GTK Widget, from spice-client-gtk"> +<meta name="generator" content="GTK-Doc V1.24 (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="#SpiceWebdavChannel.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#SpiceWebdavChannel.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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="SpicePortChannel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="ch03.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="SpiceWebdavChannel"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="SpiceWebdavChannel.top_of_page"></a>WebDAV Channel</span></h2> +<p>WebDAV Channel — exports a directory</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="SpiceWebdavChannel.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="SpiceWebdavChannel.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceWebdavChannel.html#SpiceWebdavChannel-struct" title="struct SpiceWebdavChannel">SpiceWebdavChannel</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="SpiceWebdavChannel.html#SpiceWebdavChannelClass" title="struct SpiceWebdavChannelClass">SpiceWebdavChannelClass</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SpiceWebdavChannel.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">╰──</span> <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> + <span class="lineart">╰──</span> <a class="link" href="SpicePortChannel.html" title="Port Channel">SpicePortChannel</a> + <span class="lineart">╰──</span> SpiceWebdavChannel +</pre> +</div> +<div class="refsect1"> +<a name="SpiceWebdavChannel.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-client.h> +</pre> +</div> +<div class="refsect1"> +<a name="SpiceWebdavChannel.description"></a><h2>Description</h2> +<p>The "webdav" channel exports a directory to the guest for file +manipulation (read/write/copy etc). The underlying protocol is +implemented using WebDAV (RFC 4918).</p> +<p>By default, the shared directory is the one associated with GLib +<a href="/usr/share/gtk-doc/html/glib/glib-Miscellaneous-Utility-Functions.html#G-USER-DIRECTORY-PUBLIC-SHARE:CAPS"><code class="literal">G_USER_DIRECTORY_PUBLIC_SHARE</code></a>. You can specify a different +directory with <a class="link" href="SpiceSession.html" title="Spice Session"><span class="type">SpiceSession</span></a> <a class="link" href="SpiceSession.html#SpiceSession--shared-dir" title="The “shared-dir” property"><span class="type">“shared-dir”</span></a> property.</p> +</div> +<div class="refsect1"> +<a name="SpiceWebdavChannel.functions_details"></a><h2>Functions</h2> +<p></p> +</div> +<div class="refsect1"> +<a name="SpiceWebdavChannel.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SpiceWebdavChannel-struct"></a><h3>struct SpiceWebdavChannel</h3> +<pre class="programlisting">struct SpiceWebdavChannel;</pre> +<p>The <a class="link" href="SpiceWebdavChannel.html" title="WebDAV Channel"><span class="type">SpiceWebdavChannel</span></a> struct is opaque and should not be accessed directly.</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceWebdavChannelClass"></a><h3>struct SpiceWebdavChannelClass</h3> +<pre class="programlisting">struct SpiceWebdavChannelClass { + SpicePortChannelClass parent_class; +}; +</pre> +<p>Class structure for <a class="link" href="SpiceWebdavChannel.html" title="WebDAV Channel"><span class="type">SpiceWebdavChannel</span></a>.</p> +<div class="refsect3"> +<a name="id-1.2.3.13.9.3.5"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody><tr> +<td class="struct_member_name"><p><a class="link" href="SpicePortChannel.html#SpicePortChannelClass" title="struct SpicePortChannelClass"><span class="type">SpicePortChannelClass</span></a> <em class="structfield"><code><a name="SpiceWebdavChannelClass.parent-class"></a>parent_class</code></em>;</p></td> +<td class="struct_member_description"><p>Parent class.</p></td> +<td class="struct_member_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="SpiceWebdavChannel.see-also"></a><h2>See Also</h2> +<p><a class="link" href="SpiceChannel.html" title="Spice Channel"><span class="type">SpiceChannel</span></a></p> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/annotation-glossary.html b/content-extra/api/spice-gtk/annotation-glossary.html new file mode 100644 index 0000000..838b3cc --- /dev/null +++ b/content-extra/api/spice-gtk/annotation-glossary.html @@ -0,0 +1,69 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Annotation Glossary: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="prev" href="api-index-deprecated.html" title="Index of deprecated symbols"> +<meta name="generator" content="GTK-Doc V1.24 (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"><span id="nav_glossary"><a class="shortcut" href="#glsA">A</a> + <span class="dim">|</span> + <a class="shortcut" href="#glsC">C</a> + <span class="dim">|</span> + <a class="shortcut" href="#glsE">E</a> + <span class="dim">|</span> + <a class="shortcut" href="#glsS">S</a> + <span class="dim">|</span> + <a class="shortcut" href="#glsT">T</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><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="api-index-deprecated.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><img src="right-insensitive.png" width="16" height="16" border="0"></td> +</tr></table> +<div class="glossary"> +<div class="titlepage"><div><div><h1 class="title"> +<a name="annotation-glossary"></a>Annotation Glossary</h1></div></div></div> +<a name="glsA"></a><h3 class="title">A</h3> +<dt><span class="glossterm"><a name="annotation-glossterm-allow-none"></a>allow-none</span></dt> +<dd class="glossdef"><p>NULL is OK, both for passing and for returning.</p></dd> +<dt><span class="glossterm"><a name="annotation-glossterm-array"></a>array</span></dt> +<dd class="glossdef"><p>Parameter points to an array of items.</p></dd> +<a name="glsC"></a><h3 class="title">C</h3> +<dt><span class="glossterm"><a name="annotation-glossterm-closure"></a>closure</span></dt> +<dd class="glossdef"><p>This parameter is a 'user_data', for callbacks; many bindings can pass NULL here.</p></dd> +<a name="glsE"></a><h3 class="title">E</h3> +<dt><span class="glossterm"><a name="annotation-glossterm-element-type"></a>element-type</span></dt> +<dd class="glossdef"><p>Generics and defining elements of containers and arrays.</p></dd> +<a name="glsS"></a><h3 class="title">S</h3> +<dt><span class="glossterm"><a name="annotation-glossterm-scope%20async"></a>scope async</span></dt> +<dd class="glossdef"><p>The callback is valid until first called.</p></dd> +<dt><span class="glossterm"><a name="annotation-glossterm-scope%20call"></a>scope call</span></dt> +<dd class="glossdef"><p>The callback is valid only during the call to the method.</p></dd> +<dt><span class="glossterm"><a name="annotation-glossterm-skip"></a>skip</span></dt> +<dd class="glossdef"><p>Exposed in C code, not necessarily available in other languages.</p></dd> +<dt><span class="glossterm"><a name="annotation-glossterm-Stable"></a>Stable</span></dt> +<dd class="glossdef"><p>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. +</p></dd> +<a name="glsT"></a><h3 class="title">T</h3> +<dt><span class="glossterm"><a name="annotation-glossterm-transfer%20container"></a>transfer container</span></dt> +<dd class="glossdef"><p>Free data container after the code is done.</p></dd> +<dt><span class="glossterm"><a name="annotation-glossterm-transfer%20full"></a>transfer full</span></dt> +<dd class="glossdef"><p>Free data after the code is done.</p></dd> +<dt><span class="glossterm"><a name="annotation-glossterm-transfer%20none"></a>transfer none</span></dt> +<dd class="glossdef"><p>Don't free data after the code is done.</p></dd> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/api-index-deprecated.html b/content-extra/api/spice-gtk/api-index-deprecated.html new file mode 100644 index 0000000..b6f69da --- /dev/null +++ b/content-extra/api/spice-gtk/api-index-deprecated.html @@ -0,0 +1,95 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Index of deprecated symbols: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="prev" href="api-index-full.html" title="API Index"> +<link rel="next" href="annotation-glossary.html" title="Annotation Glossary"> +<meta name="generator" content="GTK-Doc V1.24 (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"><span id="nav_index"><a class="shortcut" href="#idxA">A</a> + <span class="dim">|</span> + <a class="shortcut" href="#idxC">C</a> + <span class="dim">|</span> + <a class="shortcut" href="#idxD">D</a> + <span class="dim">|</span> + <a class="shortcut" href="#idxM">M</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><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="api-index-full.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="annotation-glossary.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="index"> +<div class="titlepage"><div><div><h1 class="title"> +<a name="api-index-deprecated"></a>Index of deprecated symbols</h1></div></div></div> +<a name="idx"></a><a name="idxA"></a><h3 class="title">A</h3> +<dt> +<a class="link" href="SpiceAudio.html#spice-audio-new" title="spice_audio_new ()">spice_audio_new</a>, function in <a class="link" href="SpiceAudio.html" title="Spice Audio">SpiceAudio</a> +</dt> +<dd></dd> +<a name="idxC"></a><h3 class="title">C</h3> +<dt> +<a class="link" href="SpiceChannel.html#spice-channel-destroy" title="spice_channel_destroy ()">spice_channel_destroy</a>, function in <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceChannel.html#spice-channel-set-capability" title="spice_channel_set_capability ()">spice_channel_set_capability</a>, function in <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> +</dt> +<dd></dd> +<a name="idxD"></a><h3 class="title">D</h3> +<dt> +<a class="link" href="SpiceDisplay.html#SpiceDisplay--auto-clipboard" title="The “auto-clipboard” property">SpiceDisplay:auto-clipboard</a>, object property in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#spice-display-copy-to-guest" title="spice_display_copy_to_guest ()">spice_display_copy_to_guest</a>, function in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#spice-display-paste-from-guest" title="spice_display_paste_from_guest ()">spice_display_paste_from_guest</a>, function in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<a name="idxM"></a><h3 class="title">M</h3> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-clipboard" title="The “main-clipboard” signal">SpiceMainChannel::main-clipboard</a>, object signal in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-grab" title="The “main-clipboard-grab” signal">SpiceMainChannel::main-clipboard-grab</a>, object signal in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-release" title="The “main-clipboard-release” signal">SpiceMainChannel::main-clipboard-release</a>, object signal in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-request" title="The “main-clipboard-request” signal">SpiceMainChannel::main-clipboard-request</a>, object signal in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#spice-main-clipboard-grab" title="spice_main_clipboard_grab ()">spice_main_clipboard_grab</a>, function in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#spice-main-clipboard-notify" title="spice_main_clipboard_notify ()">spice_main_clipboard_notify</a>, function in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#spice-main-clipboard-release" title="spice_main_clipboard_release ()">spice_main_clipboard_release</a>, function in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#spice-main-clipboard-request" title="spice_main_clipboard_request ()">spice_main_clipboard_request</a>, function in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/api-index-full.html b/content-extra/api/spice-gtk/api-index-full.html new file mode 100644 index 0000000..b007529 --- /dev/null +++ b/content-extra/api/spice-gtk/api-index-full.html @@ -0,0 +1,1271 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>API Index: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="prev" href="object-tree.html" title="Object Hierarchy"> +<link rel="next" href="api-index-deprecated.html" title="Index of deprecated symbols"> +<meta name="generator" content="GTK-Doc V1.24 (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"><span id="nav_index"><a class="shortcut" href="#idxA">A</a> + <span class="dim">|</span> + <a class="shortcut" href="#idxC">C</a> + <span class="dim">|</span> + <a class="shortcut" href="#idxD">D</a> + <span class="dim">|</span> + <a class="shortcut" href="#idxF">F</a> + <span class="dim">|</span> + <a class="shortcut" href="#idxG">G</a> + <span class="dim">|</span> + <a class="shortcut" href="#idxI">I</a> + <span class="dim">|</span> + <a class="shortcut" href="#idxM">M</a> + <span class="dim">|</span> + <a class="shortcut" href="#idxP">P</a> + <span class="dim">|</span> + <a class="shortcut" href="#idxR">R</a> + <span class="dim">|</span> + <a class="shortcut" href="#idxS">S</a> + <span class="dim">|</span> + <a class="shortcut" href="#idxU">U</a> + <span class="dim">|</span> + <a class="shortcut" href="#idxW">W</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><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="object-tree.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="api-index-deprecated.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="index"> +<div class="titlepage"><div><div><h1 class="title"> +<a name="api-index-full"></a>API Index</h1></div></div></div> +<a name="idx"></a><a name="idxA"></a><h3 class="title">A</h3> +<dt> +<a class="link" href="SpiceAudio.html#SpiceAudio-struct" title="struct SpiceAudio">SpiceAudio</a>, struct in <a class="link" href="SpiceAudio.html" title="Spice Audio">SpiceAudio</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceAudio.html#SpiceAudio--main-context" title="The “main-context” property">SpiceAudio:main-context</a>, object property in <a class="link" href="SpiceAudio.html" title="Spice Audio">SpiceAudio</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceAudio.html#SpiceAudio--session" title="The “session” property">SpiceAudio:session</a>, object property in <a class="link" href="SpiceAudio.html" title="Spice Audio">SpiceAudio</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceAudio.html#SpiceAudioClass" title="struct SpiceAudioClass">SpiceAudioClass</a>, struct in <a class="link" href="SpiceAudio.html" title="Spice Audio">SpiceAudio</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceAudio.html#spice-audio-get" title="spice_audio_get ()">spice_audio_get</a>, function in <a class="link" href="SpiceAudio.html" title="Spice Audio">SpiceAudio</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceAudio.html#spice-audio-new" title="spice_audio_new ()">spice_audio_new</a>, function in <a class="link" href="SpiceAudio.html" title="Spice Audio">SpiceAudio</a> +</dt> +<dd></dd> +<a name="idxC"></a><h3 class="title">C</h3> +<dt> +<a class="link" href="SpiceChannel.html#SpiceChannel-struct" title="SpiceChannel">SpiceChannel</a>, struct in <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceChannel.html#SpiceChannel-channel-event" title="The “channel-event” signal">SpiceChannel::channel-event</a>, object signal in <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceChannel.html#SpiceChannel-open-fd" title="The “open-fd” signal">SpiceChannel::open-fd</a>, object signal in <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceChannel.html#SpiceChannel--channel-id" title="The “channel-id” property">SpiceChannel:channel-id</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--channel-type" title="The “channel-type” property">SpiceChannel:channel-type</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> +<dt> +<a class="link" href="SpiceChannel.html#SpiceChannel--total-read-bytes" title="The “total-read-bytes” property">SpiceChannel:total-read-bytes</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#SpiceChannelClass" title="SpiceChannelClass">SpiceChannelClass</a>, struct in <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceChannel.html#SpiceChannelEvent" title="enum SpiceChannelEvent">SpiceChannelEvent</a>, enum in <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceChannel.html#spice-channel-connect" title="spice_channel_connect ()">spice_channel_connect</a>, function in <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceChannel.html#spice-channel-destroy" title="spice_channel_destroy ()">spice_channel_destroy</a>, function in <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceChannel.html#spice-channel-disconnect" title="spice_channel_disconnect ()">spice_channel_disconnect</a>, function in <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceChannel.html#spice-channel-flush-async" title="spice_channel_flush_async ()">spice_channel_flush_async</a>, function in <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceChannel.html#spice-channel-flush-finish" title="spice_channel_flush_finish ()">spice_channel_flush_finish</a>, function in <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceChannel.html#spice-channel-get-error" title="spice_channel_get_error ()">spice_channel_get_error</a>, function in <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceChannel.html#spice-channel-new" title="spice_channel_new ()">spice_channel_new</a>, function in <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceChannel.html#spice-channel-open-fd" title="spice_channel_open_fd ()">spice_channel_open_fd</a>, function in <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceChannel.html#spice-channel-set-capability" title="spice_channel_set_capability ()">spice_channel_set_capability</a>, function in <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceChannel.html#spice-channel-string-to-type" title="spice_channel_string_to_type ()">spice_channel_string_to_type</a>, function in <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceChannel.html#spice-channel-test-capability" title="spice_channel_test_capability ()">spice_channel_test_capability</a>, function in <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceChannel.html#spice-channel-test-common-capability" title="spice_channel_test_common_capability ()">spice_channel_test_common_capability</a>, function in <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceChannel.html#spice-channel-type-to-string" title="spice_channel_type_to_string ()">spice_channel_type_to_string</a>, function in <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceClientError" title="enum SpiceClientError">SpiceClientError</a>, enum in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SPICE-CLIENT-ERROR:CAPS" title="SPICE_CLIENT_ERROR">SPICE_CLIENT_ERROR</a>, macro in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#spice-client-error-quark" title="spice_client_error_quark ()">spice_client_error_quark</a>, function in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceCursorChannel.html#SpiceCursorChannel-struct" title="struct SpiceCursorChannel">SpiceCursorChannel</a>, struct in <a class="link" href="SpiceCursorChannel.html" title="Cursor Channel">SpiceCursorChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceCursorChannel.html#SpiceCursorChannel-cursor-hide" title="The “cursor-hide” signal">SpiceCursorChannel::cursor-hide</a>, object signal in <a class="link" href="SpiceCursorChannel.html" title="Cursor Channel">SpiceCursorChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceCursorChannel.html#SpiceCursorChannel-cursor-move" title="The “cursor-move” signal">SpiceCursorChannel::cursor-move</a>, object signal in <a class="link" href="SpiceCursorChannel.html" title="Cursor Channel">SpiceCursorChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceCursorChannel.html#SpiceCursorChannel-cursor-reset" title="The “cursor-reset” signal">SpiceCursorChannel::cursor-reset</a>, object signal in <a class="link" href="SpiceCursorChannel.html" title="Cursor Channel">SpiceCursorChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceCursorChannel.html#SpiceCursorChannel-cursor-set" title="The “cursor-set” signal">SpiceCursorChannel::cursor-set</a>, object signal in <a class="link" href="SpiceCursorChannel.html" title="Cursor Channel">SpiceCursorChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceCursorChannel.html#SpiceCursorChannelClass" title="struct SpiceCursorChannelClass">SpiceCursorChannelClass</a>, struct in <a class="link" href="SpiceCursorChannel.html" title="Cursor Channel">SpiceCursorChannel</a> +</dt> +<dd></dd> +<a name="idxD"></a><h3 class="title">D</h3> +<dt> +<a class="link" href="SpiceDisplay.html#SpiceDisplay-struct" title="struct SpiceDisplay">SpiceDisplay</a>, struct in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#SpiceDisplay-grab-keys-pressed" title="The “grab-keys-pressed” signal">SpiceDisplay::grab-keys-pressed</a>, object signal in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#SpiceDisplay-keyboard-grab" title="The “keyboard-grab” signal">SpiceDisplay::keyboard-grab</a>, object signal in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#SpiceDisplay-mouse-grab" title="The “mouse-grab” signal">SpiceDisplay::mouse-grab</a>, object signal in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#SpiceDisplay--auto-clipboard" title="The “auto-clipboard” property">SpiceDisplay:auto-clipboard</a>, object property in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#SpiceDisplay--channel-id" title="The “channel-id” property">SpiceDisplay:channel-id</a>, object property in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#SpiceDisplay--disable-inputs" title="The “disable-inputs” property">SpiceDisplay:disable-inputs</a>, object property in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#SpiceDisplay--grab-keyboard" title="The “grab-keyboard” property">SpiceDisplay:grab-keyboard</a>, object property in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#SpiceDisplay--grab-mouse" title="The “grab-mouse” property">SpiceDisplay:grab-mouse</a>, object property in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#SpiceDisplay--keypress-delay" title="The “keypress-delay” property">SpiceDisplay:keypress-delay</a>, object property in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#SpiceDisplay--monitor-id" title="The “monitor-id” property">SpiceDisplay:monitor-id</a>, object property in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#SpiceDisplay--only-downscale" title="The “only-downscale” property">SpiceDisplay:only-downscale</a>, object property in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#SpiceDisplay--ready" title="The “ready” property">SpiceDisplay:ready</a>, object property in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#SpiceDisplay--resize-guest" title="The “resize-guest” property">SpiceDisplay:resize-guest</a>, object property in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#SpiceDisplay--scaling" title="The “scaling” property">SpiceDisplay:scaling</a>, object property in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#SpiceDisplay--session" title="The “session” property">SpiceDisplay:session</a>, object property in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#SpiceDisplay--zoom-level" title="The “zoom-level” property">SpiceDisplay:zoom-level</a>, object property in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel-struct" title="struct SpiceDisplayChannel">SpiceDisplayChannel</a>, struct in <a class="link" href="SpiceDisplayChannel.html" title="Display Channel">SpiceDisplayChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel-display-invalidate" title="The “display-invalidate” signal">SpiceDisplayChannel::display-invalidate</a>, object signal in <a class="link" href="SpiceDisplayChannel.html" title="Display Channel">SpiceDisplayChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel-display-mark" title="The “display-mark” signal">SpiceDisplayChannel::display-mark</a>, object signal in <a class="link" href="SpiceDisplayChannel.html" title="Display Channel">SpiceDisplayChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel-display-primary-create" title="The “display-primary-create” signal">SpiceDisplayChannel::display-primary-create</a>, object signal in <a class="link" href="SpiceDisplayChannel.html" title="Display Channel">SpiceDisplayChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel-display-primary-destroy" title="The “display-primary-destroy” signal">SpiceDisplayChannel::display-primary-destroy</a>, object signal in <a class="link" href="SpiceDisplayChannel.html" title="Display Channel">SpiceDisplayChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel--height" title="The “height” property">SpiceDisplayChannel:height</a>, object property in <a class="link" href="SpiceDisplayChannel.html" title="Display Channel">SpiceDisplayChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel--monitors" title="The “monitors” property">SpiceDisplayChannel:monitors</a>, object property in <a class="link" href="SpiceDisplayChannel.html" title="Display Channel">SpiceDisplayChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel--monitors-max" title="The “monitors-max” property">SpiceDisplayChannel:monitors-max</a>, object property in <a class="link" href="SpiceDisplayChannel.html" title="Display Channel">SpiceDisplayChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannel--width" title="The “width” property">SpiceDisplayChannel:width</a>, object property in <a class="link" href="SpiceDisplayChannel.html" title="Display Channel">SpiceDisplayChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplayChannel.html#SpiceDisplayChannelClass" title="struct SpiceDisplayChannelClass">SpiceDisplayChannelClass</a>, struct in <a class="link" href="SpiceDisplayChannel.html" title="Display Channel">SpiceDisplayChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#SpiceDisplayClass" title="struct SpiceDisplayClass">SpiceDisplayClass</a>, struct in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#SpiceDisplayKeyEvent" title="enum SpiceDisplayKeyEvent">SpiceDisplayKeyEvent</a>, enum in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#spice-display-copy-to-guest" title="spice_display_copy_to_guest ()">spice_display_copy_to_guest</a>, function in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#spice-display-get-grab-keys" title="spice_display_get_grab_keys ()">spice_display_get_grab_keys</a>, function in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#spice-display-get-pixbuf" title="spice_display_get_pixbuf ()">spice_display_get_pixbuf</a>, function in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplayChannel.html#spice-display-get-primary" title="spice_display_get_primary ()">spice_display_get_primary</a>, function in <a class="link" href="SpiceDisplayChannel.html" title="Display Channel">SpiceDisplayChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#spice-display-mouse-ungrab" title="spice_display_mouse_ungrab ()">spice_display_mouse_ungrab</a>, function in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#spice-display-new" title="spice_display_new ()">spice_display_new</a>, function in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#spice-display-new-with-monitor" title="spice_display_new_with_monitor ()">spice_display_new_with_monitor</a>, function in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#spice-display-paste-from-guest" title="spice_display_paste_from_guest ()">spice_display_paste_from_guest</a>, function in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#spice-display-send-keys" title="spice_display_send_keys ()">spice_display_send_keys</a>, function in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#spice-display-set-grab-keys" title="spice_display_set_grab_keys ()">spice_display_set_grab_keys</a>, function in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<a name="idxF"></a><h3 class="title">F</h3> +<dt> +<a class="link" href="SpiceFileTransferTask.html#SpiceFileTransferTask-struct" title="struct SpiceFileTransferTask">SpiceFileTransferTask</a>, struct in <a class="link" href="SpiceFileTransferTask.html" title="File Transfer Task">SpiceFileTransferTask</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceFileTransferTask.html#SpiceFileTransferTask-finished" title="The “finished” signal">SpiceFileTransferTask::finished</a>, object signal in <a class="link" href="SpiceFileTransferTask.html" title="File Transfer Task">SpiceFileTransferTask</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceFileTransferTask.html#SpiceFileTransferTask--cancellable" title="The “cancellable” property">SpiceFileTransferTask:cancellable</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--channel" title="The “channel” property">SpiceFileTransferTask:channel</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--file" title="The “file” property">SpiceFileTransferTask:file</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--id" title="The “id” property">SpiceFileTransferTask:id</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--progress" title="The “progress” property">SpiceFileTransferTask:progress</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#SpiceFileTransferTaskClass" title="struct SpiceFileTransferTaskClass">SpiceFileTransferTaskClass</a>, struct 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> +<dt> +<a class="link" href="SpiceFileTransferTask.html#spice-file-transfer-task-get-filename" title="spice_file_transfer_task_get_filename ()">spice_file_transfer_task_get_filename</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-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> +<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> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#SpiceGrabSequence-struct" title="struct SpiceGrabSequence">SpiceGrabSequence</a>, struct in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#spice-grab-sequence-as-string" title="spice_grab_sequence_as_string ()">spice_grab_sequence_as_string</a>, function in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#spice-grab-sequence-copy" title="spice_grab_sequence_copy ()">spice_grab_sequence_copy</a>, function in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#spice-grab-sequence-free" title="spice_grab_sequence_free ()">spice_grab_sequence_free</a>, function in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#spice-grab-sequence-new" title="spice_grab_sequence_new ()">spice_grab_sequence_new</a>, function in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceDisplay.html#spice-grab-sequence-new-from-string" title="spice_grab_sequence_new_from_string ()">spice_grab_sequence_new_from_string</a>, function in <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceGtkSession.html#SpiceGtkSession-struct" title="struct SpiceGtkSession">SpiceGtkSession</a>, struct in <a class="link" href="SpiceGtkSession.html" title="Spice GTK Session">SpiceGtkSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceGtkSession.html#SpiceGtkSession--auto-clipboard" title="The “auto-clipboard” property">SpiceGtkSession:auto-clipboard</a>, object property in <a class="link" href="SpiceGtkSession.html" title="Spice GTK Session">SpiceGtkSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceGtkSession.html#SpiceGtkSession--auto-usbredir" title="The “auto-usbredir” property">SpiceGtkSession:auto-usbredir</a>, object property in <a class="link" href="SpiceGtkSession.html" title="Spice GTK Session">SpiceGtkSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceGtkSession.html#SpiceGtkSession--pointer-grabbed" title="The “pointer-grabbed” property">SpiceGtkSession:pointer-grabbed</a>, object property in <a class="link" href="SpiceGtkSession.html" title="Spice GTK Session">SpiceGtkSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceGtkSession.html#SpiceGtkSession--session" title="The “session” property">SpiceGtkSession:session</a>, object property in <a class="link" href="SpiceGtkSession.html" title="Spice GTK Session">SpiceGtkSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceGtkSession.html#SpiceGtkSessionClass" title="struct SpiceGtkSessionClass">SpiceGtkSessionClass</a>, struct in <a class="link" href="SpiceGtkSession.html" title="Spice GTK Session">SpiceGtkSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="spice-gtk-Version-Information.html#SPICE-GTK-CHECK-VERSION:CAPS" title="SPICE_GTK_CHECK_VERSION()">SPICE_GTK_CHECK_VERSION</a>, macro in <a class="link" href="spice-gtk-Version-Information.html" title="Version Information">Version Information</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="spice-gtk-Version-Information.html#SPICE-GTK-MAJOR-VERSION:CAPS" title="SPICE_GTK_MAJOR_VERSION">SPICE_GTK_MAJOR_VERSION</a>, macro in <a class="link" href="spice-gtk-Version-Information.html" title="Version Information">Version Information</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="spice-gtk-Version-Information.html#SPICE-GTK-MICRO-VERSION:CAPS" title="SPICE_GTK_MICRO_VERSION">SPICE_GTK_MICRO_VERSION</a>, macro in <a class="link" href="spice-gtk-Version-Information.html" title="Version Information">Version Information</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="spice-gtk-Version-Information.html#SPICE-GTK-MINOR-VERSION:CAPS" title="SPICE_GTK_MINOR_VERSION">SPICE_GTK_MINOR_VERSION</a>, macro in <a class="link" href="spice-gtk-Version-Information.html" title="Version Information">Version Information</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceGtkSession.html#spice-gtk-session-copy-to-guest" title="spice_gtk_session_copy_to_guest ()">spice_gtk_session_copy_to_guest</a>, function in <a class="link" href="SpiceGtkSession.html" title="Spice GTK Session">SpiceGtkSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceGtkSession.html#spice-gtk-session-get" title="spice_gtk_session_get ()">spice_gtk_session_get</a>, function in <a class="link" href="SpiceGtkSession.html" title="Spice GTK Session">SpiceGtkSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceGtkSession.html#spice-gtk-session-paste-from-guest" title="spice_gtk_session_paste_from_guest ()">spice_gtk_session_paste_from_guest</a>, function in <a class="link" href="SpiceGtkSession.html" title="Spice GTK Session">SpiceGtkSession</a> +</dt> +<dd></dd> +<a name="idxI"></a><h3 class="title">I</h3> +<dt> +<a class="link" href="SpiceInputsChannel.html#SpiceInputsChannel-struct" title="struct SpiceInputsChannel">SpiceInputsChannel</a>, struct in <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel">SpiceInputsChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceInputsChannel.html#SpiceInputsChannel-inputs-modifiers" title="The “inputs-modifiers” signal">SpiceInputsChannel::inputs-modifiers</a>, object signal in <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel">SpiceInputsChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceInputsChannel.html#SpiceInputsChannel--key-modifiers" title="The “key-modifiers” property">SpiceInputsChannel:key-modifiers</a>, object property in <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel">SpiceInputsChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceInputsChannel.html#SpiceInputsChannelClass" title="struct SpiceInputsChannelClass">SpiceInputsChannelClass</a>, struct in <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel">SpiceInputsChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceInputsChannel.html#SpiceInputsLock" title="enum SpiceInputsLock">SpiceInputsLock</a>, enum in <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel">SpiceInputsChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceInputsChannel.html#spice-inputs-button-press" title="spice_inputs_button_press ()">spice_inputs_button_press</a>, function in <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel">SpiceInputsChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceInputsChannel.html#spice-inputs-button-release" title="spice_inputs_button_release ()">spice_inputs_button_release</a>, function in <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel">SpiceInputsChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceInputsChannel.html#spice-inputs-key-press" title="spice_inputs_key_press ()">spice_inputs_key_press</a>, function in <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel">SpiceInputsChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceInputsChannel.html#spice-inputs-key-press-and-release" title="spice_inputs_key_press_and_release ()">spice_inputs_key_press_and_release</a>, function in <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel">SpiceInputsChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceInputsChannel.html#spice-inputs-key-release" title="spice_inputs_key_release ()">spice_inputs_key_release</a>, function in <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel">SpiceInputsChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceInputsChannel.html#spice-inputs-motion" title="spice_inputs_motion ()">spice_inputs_motion</a>, function in <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel">SpiceInputsChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceInputsChannel.html#spice-inputs-position" title="spice_inputs_position ()">spice_inputs_position</a>, function in <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel">SpiceInputsChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceInputsChannel.html#spice-inputs-set-key-locks" title="spice_inputs_set_key_locks ()">spice_inputs_set_key_locks</a>, function in <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel">SpiceInputsChannel</a> +</dt> +<dd></dd> +<a name="idxM"></a><h3 class="title">M</h3> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel-struct" title="struct SpiceMainChannel">SpiceMainChannel</a>, struct in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-agent-update" title="The “main-agent-update” signal">SpiceMainChannel::main-agent-update</a>, object signal in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-clipboard" title="The “main-clipboard” signal">SpiceMainChannel::main-clipboard</a>, object signal in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-grab" title="The “main-clipboard-grab” signal">SpiceMainChannel::main-clipboard-grab</a>, object signal in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-release" title="The “main-clipboard-release” signal">SpiceMainChannel::main-clipboard-release</a>, object signal in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-request" title="The “main-clipboard-request” signal">SpiceMainChannel::main-clipboard-request</a>, object signal in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-selection" title="The “main-clipboard-selection” signal">SpiceMainChannel::main-clipboard-selection</a>, object signal in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-selection-grab" title="The “main-clipboard-selection-grab” signal">SpiceMainChannel::main-clipboard-selection-grab</a>, object signal in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-selection-release" title="The “main-clipboard-selection-release” signal">SpiceMainChannel::main-clipboard-selection-release</a>, object signal in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-selection-request" title="The “main-clipboard-selection-request” signal">SpiceMainChannel::main-clipboard-selection-request</a>, object signal in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel-main-mouse-update" title="The “main-mouse-update” signal">SpiceMainChannel::main-mouse-update</a>, object signal in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel-migration-started" title="The “migration-started” signal">SpiceMainChannel::migration-started</a>, object signal in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel-new-file-transfer" title="The “new-file-transfer” signal">SpiceMainChannel::new-file-transfer</a>, object signal in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel--agent-caps-0" title="The “agent-caps-0” property">SpiceMainChannel:agent-caps-0</a>, object property in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel--agent-connected" title="The “agent-connected” property">SpiceMainChannel:agent-connected</a>, object property in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel--color-depth" title="The “color-depth” property">SpiceMainChannel:color-depth</a>, object property in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel--disable-animation" title="The “disable-animation” property">SpiceMainChannel:disable-animation</a>, object property in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel--disable-display-align" title="The “disable-display-align” property">SpiceMainChannel:disable-display-align</a>, object property in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel--disable-display-position" title="The “disable-display-position” property">SpiceMainChannel:disable-display-position</a>, object property in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel--disable-font-smooth" title="The “disable-font-smooth” property">SpiceMainChannel:disable-font-smooth</a>, object property in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel--disable-wallpaper" title="The “disable-wallpaper” property">SpiceMainChannel:disable-wallpaper</a>, object property in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel--max-clipboard" title="The “max-clipboard” property">SpiceMainChannel:max-clipboard</a>, object property in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannel--mouse-mode" title="The “mouse-mode” property">SpiceMainChannel:mouse-mode</a>, object property in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#SpiceMainChannelClass" title="struct SpiceMainChannelClass">SpiceMainChannelClass</a>, struct in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#spice-main-agent-test-capability" title="spice_main_agent_test_capability ()">spice_main_agent_test_capability</a>, function in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#spice-main-clipboard-grab" title="spice_main_clipboard_grab ()">spice_main_clipboard_grab</a>, function in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#spice-main-clipboard-notify" title="spice_main_clipboard_notify ()">spice_main_clipboard_notify</a>, function in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#spice-main-clipboard-release" title="spice_main_clipboard_release ()">spice_main_clipboard_release</a>, function in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#spice-main-clipboard-request" title="spice_main_clipboard_request ()">spice_main_clipboard_request</a>, function in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#spice-main-clipboard-selection-grab" title="spice_main_clipboard_selection_grab ()">spice_main_clipboard_selection_grab</a>, function in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#spice-main-clipboard-selection-notify" title="spice_main_clipboard_selection_notify ()">spice_main_clipboard_selection_notify</a>, function in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#spice-main-clipboard-selection-release" title="spice_main_clipboard_selection_release ()">spice_main_clipboard_selection_release</a>, function in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#spice-main-clipboard-selection-request" title="spice_main_clipboard_selection_request ()">spice_main_clipboard_selection_request</a>, function in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#spice-main-file-copy-async" title="spice_main_file_copy_async ()">spice_main_file_copy_async</a>, function in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#spice-main-file-copy-finish" title="spice_main_file_copy_finish ()">spice_main_file_copy_finish</a>, function in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#spice-main-send-monitor-config" title="spice_main_send_monitor_config ()">spice_main_send_monitor_config</a>, function in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#spice-main-set-display" title="spice_main_set_display ()">spice_main_set_display</a>, function in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#spice-main-set-display-enabled" title="spice_main_set_display_enabled ()">spice_main_set_display_enabled</a>, function in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#spice-main-update-display" title="spice_main_update_display ()">spice_main_update_display</a>, function in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceMainChannel.html#spice-main-update-display-enabled" title="spice_main_update_display_enabled ()">spice_main_update_display_enabled</a>, function in <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> +</dt> +<dd></dd> +<a name="idxP"></a><h3 class="title">P</h3> +<dt> +<a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannel-struct" title="struct SpicePlaybackChannel">SpicePlaybackChannel</a>, struct in <a class="link" href="SpicePlaybackChannel.html" title="Playback Channel">SpicePlaybackChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannel-playback-data" title="The “playback-data” signal">SpicePlaybackChannel::playback-data</a>, object signal in <a class="link" href="SpicePlaybackChannel.html" title="Playback Channel">SpicePlaybackChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannel-playback-get-delay" title="The “playback-get-delay” signal">SpicePlaybackChannel::playback-get-delay</a>, object signal in <a class="link" href="SpicePlaybackChannel.html" title="Playback Channel">SpicePlaybackChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannel-playback-start" title="The “playback-start” signal">SpicePlaybackChannel::playback-start</a>, object signal in <a class="link" href="SpicePlaybackChannel.html" title="Playback Channel">SpicePlaybackChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannel-playback-stop" title="The “playback-stop” signal">SpicePlaybackChannel::playback-stop</a>, object signal in <a class="link" href="SpicePlaybackChannel.html" title="Playback Channel">SpicePlaybackChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannel--min-latency" title="The “min-latency” property">SpicePlaybackChannel:min-latency</a>, object property in <a class="link" href="SpicePlaybackChannel.html" title="Playback Channel">SpicePlaybackChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannel--mute" title="The “mute” property">SpicePlaybackChannel:mute</a>, object property in <a class="link" href="SpicePlaybackChannel.html" title="Playback Channel">SpicePlaybackChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannel--nchannels" title="The “nchannels” property">SpicePlaybackChannel:nchannels</a>, object property in <a class="link" href="SpicePlaybackChannel.html" title="Playback Channel">SpicePlaybackChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannel--volume" title="The “volume” property">SpicePlaybackChannel:volume</a>, object property in <a class="link" href="SpicePlaybackChannel.html" title="Playback Channel">SpicePlaybackChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpicePlaybackChannel.html#SpicePlaybackChannelClass" title="struct SpicePlaybackChannelClass">SpicePlaybackChannelClass</a>, struct in <a class="link" href="SpicePlaybackChannel.html" title="Playback Channel">SpicePlaybackChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpicePlaybackChannel.html#spice-playback-channel-set-delay" title="spice_playback_channel_set_delay ()">spice_playback_channel_set_delay</a>, function in <a class="link" href="SpicePlaybackChannel.html" title="Playback Channel">SpicePlaybackChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpicePortChannel.html#SpicePortChannel-struct" title="struct SpicePortChannel">SpicePortChannel</a>, struct in <a class="link" href="SpicePortChannel.html" title="Port Channel">SpicePortChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpicePortChannel.html#SpicePortChannel-port-data" title="The “port-data” signal">SpicePortChannel::port-data</a>, object signal in <a class="link" href="SpicePortChannel.html" title="Port Channel">SpicePortChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpicePortChannel.html#SpicePortChannel-port-event" title="The “port-event” signal">SpicePortChannel::port-event</a>, object signal in <a class="link" href="SpicePortChannel.html" title="Port Channel">SpicePortChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpicePortChannel.html#SpicePortChannel--port-name" title="The “port-name” property">SpicePortChannel:port-name</a>, object property in <a class="link" href="SpicePortChannel.html" title="Port Channel">SpicePortChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpicePortChannel.html#SpicePortChannel--port-opened" title="The “port-opened” property">SpicePortChannel:port-opened</a>, object property in <a class="link" href="SpicePortChannel.html" title="Port Channel">SpicePortChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpicePortChannel.html#SpicePortChannelClass" title="struct SpicePortChannelClass">SpicePortChannelClass</a>, struct in <a class="link" href="SpicePortChannel.html" title="Port Channel">SpicePortChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpicePortChannel.html#spice-port-event" title="spice_port_event ()">spice_port_event</a>, function in <a class="link" href="SpicePortChannel.html" title="Port Channel">SpicePortChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpicePortChannel.html#spice-port-write-async" title="spice_port_write_async ()">spice_port_write_async</a>, function in <a class="link" href="SpicePortChannel.html" title="Port Channel">SpicePortChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpicePortChannel.html#spice-port-write-finish" title="spice_port_write_finish ()">spice_port_write_finish</a>, function in <a class="link" href="SpicePortChannel.html" title="Port Channel">SpicePortChannel</a> +</dt> +<dd></dd> +<a name="idxR"></a><h3 class="title">R</h3> +<dt> +<a class="link" href="SpiceRecordChannel.html#SpiceRecordChannel-struct" title="struct SpiceRecordChannel">SpiceRecordChannel</a>, struct in <a class="link" href="SpiceRecordChannel.html" title="Record Channel">SpiceRecordChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceRecordChannel.html#SpiceRecordChannel-record-start" title="The “record-start” signal">SpiceRecordChannel::record-start</a>, object signal in <a class="link" href="SpiceRecordChannel.html" title="Record Channel">SpiceRecordChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceRecordChannel.html#SpiceRecordChannel-record-stop" title="The “record-stop” signal">SpiceRecordChannel::record-stop</a>, object signal in <a class="link" href="SpiceRecordChannel.html" title="Record Channel">SpiceRecordChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceRecordChannel.html#SpiceRecordChannel--mute" title="The “mute” property">SpiceRecordChannel:mute</a>, object property in <a class="link" href="SpiceRecordChannel.html" title="Record Channel">SpiceRecordChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceRecordChannel.html#SpiceRecordChannel--nchannels" title="The “nchannels” property">SpiceRecordChannel:nchannels</a>, object property in <a class="link" href="SpiceRecordChannel.html" title="Record Channel">SpiceRecordChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceRecordChannel.html#SpiceRecordChannel--volume" title="The “volume” property">SpiceRecordChannel:volume</a>, object property in <a class="link" href="SpiceRecordChannel.html" title="Record Channel">SpiceRecordChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceRecordChannel.html#SpiceRecordChannelClass" title="struct SpiceRecordChannelClass">SpiceRecordChannelClass</a>, struct in <a class="link" href="SpiceRecordChannel.html" title="Record Channel">SpiceRecordChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceRecordChannel.html#spice-record-send-data" title="spice_record_send_data ()">spice_record_send_data</a>, function in <a class="link" href="SpiceRecordChannel.html" title="Record Channel">SpiceRecordChannel</a> +</dt> +<dd></dd> +<a name="idxS"></a><h3 class="title">S</h3> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession-struct" title="SpiceSession">SpiceSession</a>, struct in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession-channel-destroy" title="The “channel-destroy” signal">SpiceSession::channel-destroy</a>, object signal in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession-channel-new" title="The “channel-new” signal">SpiceSession::channel-new</a>, object signal in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession-mm-time-reset" title="The “mm-time-reset” signal">SpiceSession::mm-time-reset</a>, object signal in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--ca" title="The “ca” property">SpiceSession:ca</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--ca-file" title="The “ca-file” property">SpiceSession:ca-file</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--cache-size" title="The “cache-size” property">SpiceSession:cache-size</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--cert-subject" title="The “cert-subject” property">SpiceSession:cert-subject</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--ciphers" title="The “ciphers” property">SpiceSession:ciphers</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--client-sockets" title="The “client-sockets” property">SpiceSession:client-sockets</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--color-depth" title="The “color-depth” property">SpiceSession:color-depth</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--disable-effects" title="The “disable-effects” property">SpiceSession:disable-effects</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--enable-audio" title="The “enable-audio” property">SpiceSession:enable-audio</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--enable-smartcard" title="The “enable-smartcard” property">SpiceSession:enable-smartcard</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--enable-usbredir" title="The “enable-usbredir” property">SpiceSession:enable-usbredir</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--glz-window-size" title="The “glz-window-size” property">SpiceSession:glz-window-size</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--host" title="The “host” property">SpiceSession:host</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--inhibit-keyboard-grab" title="The “inhibit-keyboard-grab” property">SpiceSession:inhibit-keyboard-grab</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--migration-state" title="The “migration-state” property">SpiceSession:migration-state</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--name" title="The “name” property">SpiceSession:name</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--password" title="The “password” property">SpiceSession:password</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--port" title="The “port” property">SpiceSession:port</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--preferred-compression" title="The “preferred-compression” property">SpiceSession:preferred-compression</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--protocol" title="The “protocol” property">SpiceSession:protocol</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--proxy" title="The “proxy” property">SpiceSession:proxy</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--pubkey" title="The “pubkey” property">SpiceSession:pubkey</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--read-only" title="The “read-only” property">SpiceSession:read-only</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--secure-channels" title="The “secure-channels” property">SpiceSession:secure-channels</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--share-dir-ro" title="The “share-dir-ro” property">SpiceSession:share-dir-ro</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--shared-dir" title="The “shared-dir” property">SpiceSession:shared-dir</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--smartcard-certificates" title="The “smartcard-certificates” property">SpiceSession:smartcard-certificates</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--smartcard-db" title="The “smartcard-db” property">SpiceSession:smartcard-db</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--tls-port" title="The “tls-port” property">SpiceSession:tls-port</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--unix-path" title="The “unix-path” property">SpiceSession:unix-path</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--uri" title="The “uri” property">SpiceSession:uri</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--username" title="The “username” property">SpiceSession:username</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--uuid" title="The “uuid” property">SpiceSession:uuid</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSession--verify" title="The “verify” property">SpiceSession:verify</a>, object property in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSessionClass" title="SpiceSessionClass">SpiceSessionClass</a>, struct in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSessionMigration" title="enum SpiceSessionMigration">SpiceSessionMigration</a>, enum in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#SpiceSessionVerify" title="enum SpiceSessionVerify">SpiceSessionVerify</a>, enum in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#spice-session-connect" title="spice_session_connect ()">spice_session_connect</a>, function in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#spice-session-disconnect" title="spice_session_disconnect ()">spice_session_disconnect</a>, function in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#spice-session-get-channels" title="spice_session_get_channels ()">spice_session_get_channels</a>, function in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#spice-session-get-proxy-uri" title="spice_session_get_proxy_uri ()">spice_session_get_proxy_uri</a>, function in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#spice-session-get-read-only" title="spice_session_get_read_only ()">spice_session_get_read_only</a>, function in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#spice-session-has-channel-type" title="spice_session_has_channel_type ()">spice_session_has_channel_type</a>, function in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#spice-session-is-for-migration" title="spice_session_is_for_migration ()">spice_session_is_for_migration</a>, function in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#spice-session-new" title="spice_session_new ()">spice_session_new</a>, function in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#spice-session-open-fd" title="spice_session_open_fd ()">spice_session_open_fd</a>, function in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSession.html#spice-set-session-option" title="spice_set_session_option ()">spice_set_session_option</a>, function in <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSmartcardChannel.html#SpiceSmartcardChannel-struct" title="struct SpiceSmartcardChannel">SpiceSmartcardChannel</a>, struct in <a class="link" href="SpiceSmartcardChannel.html" title="Smartcard Channel">SpiceSmartcardChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSmartcardChannel.html#SpiceSmartcardChannelClass" title="struct SpiceSmartcardChannelClass">SpiceSmartcardChannelClass</a>, struct in <a class="link" href="SpiceSmartcardChannel.html" title="Smartcard Channel">SpiceSmartcardChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardManager-struct" title="struct SpiceSmartcardManager">SpiceSmartcardManager</a>, struct in <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager">SpiceSmartcardManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardManager-card-inserted" title="The “card-inserted” signal">SpiceSmartcardManager::card-inserted</a>, object signal in <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager">SpiceSmartcardManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardManager-card-removed" title="The “card-removed” signal">SpiceSmartcardManager::card-removed</a>, object signal in <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager">SpiceSmartcardManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardManager-reader-added" title="The “reader-added” signal">SpiceSmartcardManager::reader-added</a>, object signal in <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager">SpiceSmartcardManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardManager-reader-removed" title="The “reader-removed” signal">SpiceSmartcardManager::reader-removed</a>, object signal in <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager">SpiceSmartcardManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardManagerClass" title="struct SpiceSmartcardManagerClass">SpiceSmartcardManagerClass</a>, struct in <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager">SpiceSmartcardManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSmartcardManager.html#SpiceSmartcardReader" title="SpiceSmartcardReader">SpiceSmartcardReader</a>, struct in <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager">SpiceSmartcardManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSmartcardManager.html#spice-smartcard-manager-get" title="spice_smartcard_manager_get ()">spice_smartcard_manager_get</a>, function in <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager">SpiceSmartcardManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSmartcardManager.html#spice-smartcard-manager-get-readers" title="spice_smartcard_manager_get_readers ()">spice_smartcard_manager_get_readers</a>, function in <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager">SpiceSmartcardManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSmartcardManager.html#spice-smartcard-manager-insert-card" title="spice_smartcard_manager_insert_card ()">spice_smartcard_manager_insert_card</a>, function in <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager">SpiceSmartcardManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSmartcardManager.html#spice-smartcard-manager-remove-card" title="spice_smartcard_manager_remove_card ()">spice_smartcard_manager_remove_card</a>, function in <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager">SpiceSmartcardManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSmartcardManager.html#spice-smartcard-reader-insert-card" title="spice_smartcard_reader_insert_card ()">spice_smartcard_reader_insert_card</a>, function in <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager">SpiceSmartcardManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSmartcardManager.html#spice-smartcard-reader-is-software" title="spice_smartcard_reader_is_software ()">spice_smartcard_reader_is_software</a>, function in <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager">SpiceSmartcardManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceSmartcardManager.html#spice-smartcard-reader-remove-card" title="spice_smartcard_reader_remove_card ()">spice_smartcard_reader_remove_card</a>, function in <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager">SpiceSmartcardManager</a> +</dt> +<dd></dd> +<a name="idxU"></a><h3 class="title">U</h3> +<dt> +<a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI">SpiceURI</a>, struct in <a class="link" href="spice-gtk-SpiceURI.html" title="SpiceURI">SpiceURI</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="spice-gtk-SpiceURI.html#SpiceURIClass" title="SpiceURIClass">SpiceURIClass</a>, struct in <a class="link" href="spice-gtk-SpiceURI.html" title="SpiceURI">SpiceURI</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="spice-gtk-SpiceURI.html#spice-uri-get-hostname" title="spice_uri_get_hostname ()">spice_uri_get_hostname</a>, function in <a class="link" href="spice-gtk-SpiceURI.html" title="SpiceURI">SpiceURI</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="spice-gtk-SpiceURI.html#spice-uri-get-password" title="spice_uri_get_password ()">spice_uri_get_password</a>, function in <a class="link" href="spice-gtk-SpiceURI.html" title="SpiceURI">SpiceURI</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="spice-gtk-SpiceURI.html#spice-uri-get-port" title="spice_uri_get_port ()">spice_uri_get_port</a>, function in <a class="link" href="spice-gtk-SpiceURI.html" title="SpiceURI">SpiceURI</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="spice-gtk-SpiceURI.html#spice-uri-get-scheme" title="spice_uri_get_scheme ()">spice_uri_get_scheme</a>, function in <a class="link" href="spice-gtk-SpiceURI.html" title="SpiceURI">SpiceURI</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="spice-gtk-SpiceURI.html#spice-uri-get-user" title="spice_uri_get_user ()">spice_uri_get_user</a>, function in <a class="link" href="spice-gtk-SpiceURI.html" title="SpiceURI">SpiceURI</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="spice-gtk-SpiceURI.html#spice-uri-set-hostname" title="spice_uri_set_hostname ()">spice_uri_set_hostname</a>, function in <a class="link" href="spice-gtk-SpiceURI.html" title="SpiceURI">SpiceURI</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="spice-gtk-SpiceURI.html#spice-uri-set-password" title="spice_uri_set_password ()">spice_uri_set_password</a>, function in <a class="link" href="spice-gtk-SpiceURI.html" title="SpiceURI">SpiceURI</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="spice-gtk-SpiceURI.html#spice-uri-set-port" title="spice_uri_set_port ()">spice_uri_set_port</a>, function in <a class="link" href="spice-gtk-SpiceURI.html" title="SpiceURI">SpiceURI</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="spice-gtk-SpiceURI.html#spice-uri-set-scheme" title="spice_uri_set_scheme ()">spice_uri_set_scheme</a>, function in <a class="link" href="spice-gtk-SpiceURI.html" title="SpiceURI">SpiceURI</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="spice-gtk-SpiceURI.html#spice-uri-set-user" title="spice_uri_set_user ()">spice_uri_set_user</a>, function in <a class="link" href="spice-gtk-SpiceURI.html" title="SpiceURI">SpiceURI</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="spice-gtk-SpiceURI.html#spice-uri-to-string" title="spice_uri_to_string ()">spice_uri_to_string</a>, function in <a class="link" href="spice-gtk-SpiceURI.html" title="SpiceURI">SpiceURI</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice-struct" title="SpiceUsbDevice">SpiceUsbDevice</a>, struct in <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager">SpiceUsbDeviceManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-struct" title="struct SpiceUsbDeviceManager">SpiceUsbDeviceManager</a>, struct in <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager">SpiceUsbDeviceManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-auto-connect-failed" title="The “auto-connect-failed” signal">SpiceUsbDeviceManager::auto-connect-failed</a>, object signal in <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager">SpiceUsbDeviceManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-device-added" title="The “device-added” signal">SpiceUsbDeviceManager::device-added</a>, object signal in <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager">SpiceUsbDeviceManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-device-error" title="The “device-error” signal">SpiceUsbDeviceManager::device-error</a>, object signal in <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager">SpiceUsbDeviceManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-device-removed" title="The “device-removed” signal">SpiceUsbDeviceManager::device-removed</a>, object signal in <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager">SpiceUsbDeviceManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager--auto-connect" title="The “auto-connect” property">SpiceUsbDeviceManager:auto-connect</a>, object property in <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager">SpiceUsbDeviceManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager--auto-connect-filter" title="The “auto-connect-filter” property">SpiceUsbDeviceManager:auto-connect-filter</a>, object property in <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager">SpiceUsbDeviceManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager--redirect-on-connect" title="The “redirect-on-connect” property">SpiceUsbDeviceManager:redirect-on-connect</a>, object property in <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager">SpiceUsbDeviceManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager--session" title="The “session” property">SpiceUsbDeviceManager:session</a>, object property in <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager">SpiceUsbDeviceManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDeviceManagerClass" title="struct SpiceUsbDeviceManagerClass">SpiceUsbDeviceManagerClass</a>, struct in <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager">SpiceUsbDeviceManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget-struct" title="struct SpiceUsbDeviceWidget">SpiceUsbDeviceWidget</a>, struct in <a class="link" href="SpiceUsbDeviceWidget.html" title="Spice USB device selection widget">SpiceUsbDeviceWidget</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget-connect-failed" title="The “connect-failed” signal">SpiceUsbDeviceWidget::connect-failed</a>, object signal in <a class="link" href="SpiceUsbDeviceWidget.html" title="Spice USB device selection widget">SpiceUsbDeviceWidget</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget--device-format-string" title="The “device-format-string” property">SpiceUsbDeviceWidget:device-format-string</a>, object property in <a class="link" href="SpiceUsbDeviceWidget.html" title="Spice USB device selection widget">SpiceUsbDeviceWidget</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget--session" title="The “session” property">SpiceUsbDeviceWidget:session</a>, object property in <a class="link" href="SpiceUsbDeviceWidget.html" title="Spice USB device selection widget">SpiceUsbDeviceWidget</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidgetClass" title="struct SpiceUsbDeviceWidgetClass">SpiceUsbDeviceWidgetClass</a>, struct in <a class="link" href="SpiceUsbDeviceWidget.html" title="Spice USB device selection widget">SpiceUsbDeviceWidget</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbredirChannel.html#SpiceUsbredirChannel-struct" title="struct SpiceUsbredirChannel">SpiceUsbredirChannel</a>, struct in <a class="link" href="SpiceUsbredirChannel.html" title="USB Redirection Channel">SpiceUsbredirChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbredirChannel.html#SpiceUsbredirChannelClass" title="struct SpiceUsbredirChannelClass">SpiceUsbredirChannelClass</a>, struct in <a class="link" href="SpiceUsbredirChannel.html" title="USB Redirection Channel">SpiceUsbredirChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceManager.html#spice-usb-device-get-description" title="spice_usb_device_get_description ()">spice_usb_device_get_description</a>, function in <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager">SpiceUsbDeviceManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceManager.html#spice-usb-device-get-libusb-device" title="spice_usb_device_get_libusb_device ()">spice_usb_device_get_libusb_device</a>, function in <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager">SpiceUsbDeviceManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceManager.html#spice-usb-device-manager-can-redirect-device" title="spice_usb_device_manager_can_redirect_device ()">spice_usb_device_manager_can_redirect_device</a>, function in <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager">SpiceUsbDeviceManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceManager.html#spice-usb-device-manager-connect-device-async" title="spice_usb_device_manager_connect_device_async ()">spice_usb_device_manager_connect_device_async</a>, function in <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager">SpiceUsbDeviceManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceManager.html#spice-usb-device-manager-connect-device-finish" title="spice_usb_device_manager_connect_device_finish ()">spice_usb_device_manager_connect_device_finish</a>, function in <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager">SpiceUsbDeviceManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceManager.html#spice-usb-device-manager-disconnect-device" title="spice_usb_device_manager_disconnect_device ()">spice_usb_device_manager_disconnect_device</a>, function in <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager">SpiceUsbDeviceManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceManager.html#spice-usb-device-manager-get" title="spice_usb_device_manager_get ()">spice_usb_device_manager_get</a>, function in <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager">SpiceUsbDeviceManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceManager.html#spice-usb-device-manager-get-devices" title="spice_usb_device_manager_get_devices ()">spice_usb_device_manager_get_devices</a>, function in <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager">SpiceUsbDeviceManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceManager.html#spice-usb-device-manager-get-devices-with-filter" title="spice_usb_device_manager_get_devices_with_filter ()">spice_usb_device_manager_get_devices_with_filter</a>, function in <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager">SpiceUsbDeviceManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceManager.html#spice-usb-device-manager-is-device-connected" title="spice_usb_device_manager_is_device_connected ()">spice_usb_device_manager_is_device_connected</a>, function in <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager">SpiceUsbDeviceManager</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceUsbDeviceWidget.html#spice-usb-device-widget-new" title="spice_usb_device_widget_new ()">spice_usb_device_widget_new</a>, function in <a class="link" href="SpiceUsbDeviceWidget.html" title="Spice USB device selection widget">SpiceUsbDeviceWidget</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="spice-gtk-Utilities.html#spice-util-get-version-string" title="spice_util_get_version_string ()">spice_util_get_version_string</a>, function in <a class="link" href="spice-gtk-Utilities.html" title="Utilities">Utilities</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="spice-gtk-Utilities.html#spice-util-set-debug" title="spice_util_set_debug ()">spice_util_set_debug</a>, function in <a class="link" href="spice-gtk-Utilities.html" title="Utilities">Utilities</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="spice-gtk-Utilities.html#spice-uuid-to-string" title="spice_uuid_to_string ()">spice_uuid_to_string</a>, function in <a class="link" href="spice-gtk-Utilities.html" title="Utilities">Utilities</a> +</dt> +<dd></dd> +<a name="idxW"></a><h3 class="title">W</h3> +<dt> +<a class="link" href="SpiceWebdavChannel.html#SpiceWebdavChannel-struct" title="struct SpiceWebdavChannel">SpiceWebdavChannel</a>, struct in <a class="link" href="SpiceWebdavChannel.html" title="WebDAV Channel">SpiceWebdavChannel</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="SpiceWebdavChannel.html#SpiceWebdavChannelClass" title="struct SpiceWebdavChannelClass">SpiceWebdavChannelClass</a>, struct in <a class="link" href="SpiceWebdavChannel.html" title="WebDAV Channel">SpiceWebdavChannel</a> +</dt> +<dd></dd> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/api-reference.html b/content-extra/api/spice-gtk/api-reference.html new file mode 100644 index 0000000..49b8029 --- /dev/null +++ b/content-extra/api/spice-gtk/api-reference.html @@ -0,0 +1,110 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Part I. API Reference: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="prev" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="next" href="ch01.html" title="Object Hierarchy"> +<meta name="generator" content="GTK-Doc V1.24 (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"></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="index.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="ch01.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="part"> +<div class="titlepage"><div><div><h1 class="title"> +<a name="api-reference"></a>Part I. API Reference</h1></div></div></div> +<div class="toc"> +<p><b>Table of Contents</b></p> +<dl class="toc"> +<dt><span class="chapter"><a href="ch01.html">Object Hierarchy</a></span></dt> +<dt><span class="chapter"><a href="ch02.html">Session and Channels Objects, from spice-client-glib</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="SpiceSession.html">Spice Session</a></span><span class="refpurpose"> — handles connection details, and active channels</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceChannel.html">Spice Channel</a></span><span class="refpurpose"> — the base channel class</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceCursorChannel.html">Cursor Channel</a></span><span class="refpurpose"> — update cursor shape and position</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceDisplayChannel.html">Display Channel</a></span><span class="refpurpose"> — remote display area</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceInputsChannel.html">Inputs Channel</a></span><span class="refpurpose"> — control the server mouse and keyboard</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceMainChannel.html">Main Channel</a></span><span class="refpurpose"> — the main Spice channel</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpicePlaybackChannel.html">Playback Channel</a></span><span class="refpurpose"> — audio stream for playback</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceRecordChannel.html">Record Channel</a></span><span class="refpurpose"> — audio stream for recording</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceSmartcardChannel.html">Smartcard Channel</a></span><span class="refpurpose"> — smartcard authentication</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceUsbredirChannel.html">USB Redirection Channel</a></span><span class="refpurpose"> — usb redirection</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpicePortChannel.html">Port Channel</a></span><span class="refpurpose"> — private communication channel</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceWebdavChannel.html">WebDAV Channel</a></span><span class="refpurpose"> — exports a directory</span> +</dt> +</dl></dd> +<dt><span class="chapter"><a href="ch03.html">GTK Widget, from spice-client-gtk</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="SpiceGtkSession.html">Spice GTK Session</a></span><span class="refpurpose"> — handles GTK connection details</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceDisplay.html">Spice Display</a></span><span class="refpurpose"> — a GTK display widget</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceUsbDeviceWidget.html">Spice USB device selection widget</a></span><span class="refpurpose"> — USB device selection widget</span> +</dt> +</dl></dd> +<dt><span class="chapter"><a href="application-support.html">Application Support, from spice-client-glib</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="SpiceAudio.html">Spice Audio</a></span><span class="refpurpose"> — a helper to play and to record audio channels</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceSmartcardManager.html">Spice Smartcard Manager</a></span><span class="refpurpose"> — smartcard management</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceUsbDeviceManager.html">Spice USB Manager</a></span><span class="refpurpose"> — USB device management</span> +</dt> +<dt> +<span class="refentrytitle"><a href="spice-gtk-Utilities.html">Utilities</a></span><span class="refpurpose"> — version and debugging functions</span> +</dt> +<dt> +<span class="refentrytitle"><a href="spice-gtk-Version-Information.html">Version Information</a></span><span class="refpurpose"> — Spice-Gtk version checking</span> +</dt> +<dt> +<span class="refentrytitle"><a href="spice-gtk-SpiceURI.html">SpiceURI</a></span><span class="refpurpose"> — URIs handling</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceFileTransferTask.html">File Transfer Task</a></span><span class="refpurpose"> — Monitoring file transfers</span> +</dt> +</dl></dd> +</dl> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/application-support.html b/content-extra/api/spice-gtk/application-support.html new file mode 100644 index 0000000..8e8a6b2 --- /dev/null +++ b/content-extra/api/spice-gtk/application-support.html @@ -0,0 +1,52 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Application Support, from spice-client-glib: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="api-reference.html" title="Part I. API Reference"> +<link rel="prev" href="SpiceUsbDeviceWidget.html" title="Spice USB device selection widget"> +<link rel="next" href="SpiceAudio.html" title="Spice Audio"> +<meta name="generator" content="GTK-Doc V1.24 (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"></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="api-reference.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="SpiceUsbDeviceWidget.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="SpiceAudio.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="application-support"></a>Application Support, from spice-client-glib</h2></div></div></div> +<div class="toc"><dl class="toc"> +<dt> +<span class="refentrytitle"><a href="SpiceAudio.html">Spice Audio</a></span><span class="refpurpose"> — a helper to play and to record audio channels</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceSmartcardManager.html">Spice Smartcard Manager</a></span><span class="refpurpose"> — smartcard management</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceUsbDeviceManager.html">Spice USB Manager</a></span><span class="refpurpose"> — USB device management</span> +</dt> +<dt> +<span class="refentrytitle"><a href="spice-gtk-Utilities.html">Utilities</a></span><span class="refpurpose"> — version and debugging functions</span> +</dt> +<dt> +<span class="refentrytitle"><a href="spice-gtk-Version-Information.html">Version Information</a></span><span class="refpurpose"> — Spice-Gtk version checking</span> +</dt> +<dt> +<span class="refentrytitle"><a href="spice-gtk-SpiceURI.html">SpiceURI</a></span><span class="refpurpose"> — URIs handling</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceFileTransferTask.html">File Transfer Task</a></span><span class="refpurpose"> — Monitoring file transfers</span> +</dt> +</dl></div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/ch01.html b/content-extra/api/spice-gtk/ch01.html new file mode 100644 index 0000000..269a0b5 --- /dev/null +++ b/content-extra/api/spice-gtk/ch01.html @@ -0,0 +1,65 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Object Hierarchy: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="api-reference.html" title="Part I. API Reference"> +<link rel="prev" href="api-reference.html" title="Part I. API Reference"> +<link rel="next" href="ch02.html" title="Session and Channels Objects, from spice-client-glib"> +<meta name="generator" content="GTK-Doc V1.24 (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"></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="api-reference.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="api-reference.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="ch02.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="id-1.2.2"></a>Object Hierarchy</h2></div></div></div> +<pre class="screen"> + <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">├──</span> <a class="link" href="SpiceAudio.html" title="Spice Audio">SpiceAudio</a> + <span class="lineart">├──</span> <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> + <span class="lineart">│</span> <span class="lineart">├──</span> <a class="link" href="SpiceCursorChannel.html" title="Cursor Channel">SpiceCursorChannel</a> + <span class="lineart">│</span> <span class="lineart">├──</span> <a class="link" href="SpiceDisplayChannel.html" title="Display Channel">SpiceDisplayChannel</a> + <span class="lineart">│</span> <span class="lineart">├──</span> <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel">SpiceInputsChannel</a> + <span class="lineart">│</span> <span class="lineart">├──</span> <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> + <span class="lineart">│</span> <span class="lineart">├──</span> <a class="link" href="SpicePlaybackChannel.html" title="Playback Channel">SpicePlaybackChannel</a> + <span class="lineart">│</span> <span class="lineart">├──</span> <a class="link" href="SpiceRecordChannel.html" title="Record Channel">SpiceRecordChannel</a> + <span class="lineart">│</span> <span class="lineart">├──</span> <a class="link" href="SpiceSmartcardChannel.html" title="Smartcard Channel">SpiceSmartcardChannel</a> + <span class="lineart">│</span> <span class="lineart">├──</span> <a class="link" href="SpiceUsbredirChannel.html" title="USB Redirection Channel">SpiceUsbredirChannel</a> + <span class="lineart">│</span> <span class="lineart">╰──</span> <a class="link" href="SpicePortChannel.html" title="Port Channel">SpicePortChannel</a> + <span class="lineart">│</span> <span class="lineart">╰──</span> <a class="link" href="SpiceWebdavChannel.html" title="WebDAV Channel">SpiceWebdavChannel</a> + <span class="lineart">├──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> + <span class="lineart">│</span> <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk2/GtkWidget.html">GtkWidget</a> + <span class="lineart">│</span> <span class="lineart">├──</span> <a href="/usr/share/gtk-doc/html/gtk2/GtkDrawingArea.html">GtkDrawingArea</a> + <span class="lineart">│</span> <span class="lineart">│</span> <span class="lineart">╰──</span> <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> + <span class="lineart">│</span> <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk2/GtkContainer.html">GtkContainer</a> + <span class="lineart">│</span> <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk2/GtkBox.html">GtkBox</a> + <span class="lineart">│</span> <span class="lineart">╰──</span> <a class="link" href="SpiceUsbDeviceWidget.html" title="Spice USB device selection widget">SpiceUsbDeviceWidget</a> + <span class="lineart">├──</span> <a class="link" href="SpiceGtkSession.html" title="Spice GTK Session">SpiceGtkSession</a> + <span class="lineart">├──</span> <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> + <span class="lineart">├──</span> <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager">SpiceSmartcardManager</a> + <span class="lineart">├──</span> <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager">SpiceUsbDeviceManager</a> + <span class="lineart">╰──</span> <a class="link" href="SpiceFileTransferTask.html" title="File Transfer Task">SpiceFileTransferTask</a> + <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a> + <span class="lineart">├──</span> <a class="link" href="SpiceChannel.html#SpiceChannelEvent" title="enum SpiceChannelEvent">SpiceChannelEvent</a> + <span class="lineart">╰──</span> <a class="link" href="SpiceSession.html#SpiceSessionMigration" title="enum SpiceSessionMigration">SpiceSessionMigration</a> + <a href="/usr/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a> + <span class="lineart">├──</span> <a class="link" href="SpiceDisplay.html#SpiceGrabSequence">SpiceGrabSequence</a> + <span class="lineart">╰──</span> <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice">SpiceUsbDevice</a> + <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GFlags</a> + <span class="lineart">├──</span> <a class="link" href="SpiceInputsChannel.html#SpiceInputsLock" title="enum SpiceInputsLock">SpiceInputsLock</a> + <span class="lineart">╰──</span> <a class="link" href="SpiceSession.html#SpiceSessionVerify" title="enum SpiceSessionVerify">SpiceSessionVerify</a> +</pre> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/ch02.html b/content-extra/api/spice-gtk/ch02.html new file mode 100644 index 0000000..cc13f2d --- /dev/null +++ b/content-extra/api/spice-gtk/ch02.html @@ -0,0 +1,67 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Session and Channels Objects, from spice-client-glib: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="api-reference.html" title="Part I. API Reference"> +<link rel="prev" href="ch01.html" title="Object Hierarchy"> +<link rel="next" href="SpiceSession.html" title="Spice Session"> +<meta name="generator" content="GTK-Doc V1.24 (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"></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="api-reference.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="SpiceSession.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="id-1.2.3"></a>Session and Channels Objects, from spice-client-glib</h2></div></div></div> +<div class="toc"><dl class="toc"> +<dt> +<span class="refentrytitle"><a href="SpiceSession.html">Spice Session</a></span><span class="refpurpose"> — handles connection details, and active channels</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceChannel.html">Spice Channel</a></span><span class="refpurpose"> — the base channel class</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceCursorChannel.html">Cursor Channel</a></span><span class="refpurpose"> — update cursor shape and position</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceDisplayChannel.html">Display Channel</a></span><span class="refpurpose"> — remote display area</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceInputsChannel.html">Inputs Channel</a></span><span class="refpurpose"> — control the server mouse and keyboard</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceMainChannel.html">Main Channel</a></span><span class="refpurpose"> — the main Spice channel</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpicePlaybackChannel.html">Playback Channel</a></span><span class="refpurpose"> — audio stream for playback</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceRecordChannel.html">Record Channel</a></span><span class="refpurpose"> — audio stream for recording</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceSmartcardChannel.html">Smartcard Channel</a></span><span class="refpurpose"> — smartcard authentication</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceUsbredirChannel.html">USB Redirection Channel</a></span><span class="refpurpose"> — usb redirection</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpicePortChannel.html">Port Channel</a></span><span class="refpurpose"> — private communication channel</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceWebdavChannel.html">WebDAV Channel</a></span><span class="refpurpose"> — exports a directory</span> +</dt> +</dl></div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/ch03.html b/content-extra/api/spice-gtk/ch03.html new file mode 100644 index 0000000..1b6a2c2 --- /dev/null +++ b/content-extra/api/spice-gtk/ch03.html @@ -0,0 +1,40 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GTK Widget, from spice-client-gtk: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="api-reference.html" title="Part I. API Reference"> +<link rel="prev" href="SpiceWebdavChannel.html" title="WebDAV Channel"> +<link rel="next" href="SpiceGtkSession.html" title="Spice GTK Session"> +<meta name="generator" content="GTK-Doc V1.24 (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"></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="api-reference.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="SpiceWebdavChannel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="SpiceGtkSession.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="id-1.2.4"></a>GTK Widget, from spice-client-gtk</h2></div></div></div> +<div class="toc"><dl class="toc"> +<dt> +<span class="refentrytitle"><a href="SpiceGtkSession.html">Spice GTK Session</a></span><span class="refpurpose"> — handles GTK connection details</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceDisplay.html">Spice Display</a></span><span class="refpurpose"> — a GTK display widget</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceUsbDeviceWidget.html">Spice USB device selection widget</a></span><span class="refpurpose"> — USB device selection widget</span> +</dt> +</dl></div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/home.png b/content-extra/api/spice-gtk/home.png Binary files differnew file mode 100644 index 0000000..9346b33 --- /dev/null +++ b/content-extra/api/spice-gtk/home.png diff --git a/content-extra/api/spice-gtk/index.html b/content-extra/api/spice-gtk/index.html new file mode 100644 index 0000000..0ebb2ef --- /dev/null +++ b/content-extra/api/spice-gtk/index.html @@ -0,0 +1,107 @@ +<!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 Reference Manual: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="next" href="api-reference.html" title="Part I. API Reference"> +<meta name="generator" content="GTK-Doc V1.24 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<div class="book"> +<div class="titlepage"> +<div><div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">Spice-GTK Reference Manual</p></th></tr></table></div></div> +<hr> +</div> +<div class="toc"><dl class="toc"> +<dt><span class="part"><a href="api-reference.html">I. API Reference</a></span></dt> +<dd><dl> +<dt><span class="chapter"><a href="ch01.html">Object Hierarchy</a></span></dt> +<dt><span class="chapter"><a href="ch02.html">Session and Channels Objects, from spice-client-glib</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="SpiceSession.html">Spice Session</a></span><span class="refpurpose"> — handles connection details, and active channels</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceChannel.html">Spice Channel</a></span><span class="refpurpose"> — the base channel class</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceCursorChannel.html">Cursor Channel</a></span><span class="refpurpose"> — update cursor shape and position</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceDisplayChannel.html">Display Channel</a></span><span class="refpurpose"> — remote display area</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceInputsChannel.html">Inputs Channel</a></span><span class="refpurpose"> — control the server mouse and keyboard</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceMainChannel.html">Main Channel</a></span><span class="refpurpose"> — the main Spice channel</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpicePlaybackChannel.html">Playback Channel</a></span><span class="refpurpose"> — audio stream for playback</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceRecordChannel.html">Record Channel</a></span><span class="refpurpose"> — audio stream for recording</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceSmartcardChannel.html">Smartcard Channel</a></span><span class="refpurpose"> — smartcard authentication</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceUsbredirChannel.html">USB Redirection Channel</a></span><span class="refpurpose"> — usb redirection</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpicePortChannel.html">Port Channel</a></span><span class="refpurpose"> — private communication channel</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceWebdavChannel.html">WebDAV Channel</a></span><span class="refpurpose"> — exports a directory</span> +</dt> +</dl></dd> +<dt><span class="chapter"><a href="ch03.html">GTK Widget, from spice-client-gtk</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="SpiceGtkSession.html">Spice GTK Session</a></span><span class="refpurpose"> — handles GTK connection details</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceDisplay.html">Spice Display</a></span><span class="refpurpose"> — a GTK display widget</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceUsbDeviceWidget.html">Spice USB device selection widget</a></span><span class="refpurpose"> — USB device selection widget</span> +</dt> +</dl></dd> +<dt><span class="chapter"><a href="application-support.html">Application Support, from spice-client-glib</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="SpiceAudio.html">Spice Audio</a></span><span class="refpurpose"> — a helper to play and to record audio channels</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceSmartcardManager.html">Spice Smartcard Manager</a></span><span class="refpurpose"> — smartcard management</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceUsbDeviceManager.html">Spice USB Manager</a></span><span class="refpurpose"> — USB device management</span> +</dt> +<dt> +<span class="refentrytitle"><a href="spice-gtk-Utilities.html">Utilities</a></span><span class="refpurpose"> — version and debugging functions</span> +</dt> +<dt> +<span class="refentrytitle"><a href="spice-gtk-Version-Information.html">Version Information</a></span><span class="refpurpose"> — Spice-Gtk version checking</span> +</dt> +<dt> +<span class="refentrytitle"><a href="spice-gtk-SpiceURI.html">SpiceURI</a></span><span class="refpurpose"> — URIs handling</span> +</dt> +<dt> +<span class="refentrytitle"><a href="SpiceFileTransferTask.html">File Transfer Task</a></span><span class="refpurpose"> — Monitoring file transfers</span> +</dt> +</dl></dd> +</dl></dd> +<dt><span class="chapter"><a href="object-tree.html">Object Hierarchy</a></span></dt> +<dt><span class="index"><a href="api-index-full.html">API Index</a></span></dt> +<dt><span class="index"><a href="api-index-deprecated.html">Index of deprecated symbols</a></span></dt> +<dt><span class="glossary"><a href="annotation-glossary.html">Annotation Glossary</a></span></dt> +</dl></div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/index.sgml b/content-extra/api/spice-gtk/index.sgml new file mode 100644 index 0000000..c7c2915 --- /dev/null +++ b/content-extra/api/spice-gtk/index.sgml @@ -0,0 +1,604 @@ +<ANCHOR id="SpiceSession" href="spice-gtk/SpiceSession.html"> +<ANCHOR id="SpiceSession.stability-level" href="spice-gtk/SpiceSession.html#SpiceSession.stability-level"> +<ANCHOR id="SpiceSession.functions" href="spice-gtk/SpiceSession.html#SpiceSession.functions"> +<ANCHOR id="SpiceSession.properties" href="spice-gtk/SpiceSession.html#SpiceSession.properties"> +<ANCHOR id="SpiceSession.signals" href="spice-gtk/SpiceSession.html#SpiceSession.signals"> +<ANCHOR id="SpiceSession.other" href="spice-gtk/SpiceSession.html#SpiceSession.other"> +<ANCHOR id="SpiceSession.object-hierarchy" href="spice-gtk/SpiceSession.html#SpiceSession.object-hierarchy"> +<ANCHOR id="SpiceSession.includes" href="spice-gtk/SpiceSession.html#SpiceSession.includes"> +<ANCHOR id="SpiceSession.description" href="spice-gtk/SpiceSession.html#SpiceSession.description"> +<ANCHOR id="SpiceSession.functions_details" href="spice-gtk/SpiceSession.html#SpiceSession.functions_details"> +<ANCHOR id="spice-session-new" href="spice-gtk/SpiceSession.html#spice-session-new"> +<ANCHOR id="spice-session-connect" href="spice-gtk/SpiceSession.html#spice-session-connect"> +<ANCHOR id="spice-session-open-fd" href="spice-gtk/SpiceSession.html#spice-session-open-fd"> +<ANCHOR id="spice-session-disconnect" href="spice-gtk/SpiceSession.html#spice-session-disconnect"> +<ANCHOR id="spice-session-get-channels" href="spice-gtk/SpiceSession.html#spice-session-get-channels"> +<ANCHOR id="spice-session-get-read-only" href="spice-gtk/SpiceSession.html#spice-session-get-read-only"> +<ANCHOR id="spice-session-has-channel-type" href="spice-gtk/SpiceSession.html#spice-session-has-channel-type"> +<ANCHOR id="spice-session-get-proxy-uri" href="spice-gtk/SpiceSession.html#spice-session-get-proxy-uri"> +<ANCHOR id="spice-session-is-for-migration" href="spice-gtk/SpiceSession.html#spice-session-is-for-migration"> +<ANCHOR id="spice-get-option-group" href="spice-gtk/SpiceSession.html#spice-get-option-group"> +<ANCHOR id="spice-set-session-option" href="spice-gtk/SpiceSession.html#spice-set-session-option"> +<ANCHOR id="spice-client-error-quark" href="spice-gtk/SpiceSession.html#spice-client-error-quark"> +<ANCHOR id="SpiceSession.other_details" href="spice-gtk/SpiceSession.html#SpiceSession.other_details"> +<ANCHOR id="SpiceSession-struct" href="spice-gtk/SpiceSession.html#SpiceSession-struct"> +<ANCHOR id="SpiceSessionClass" href="spice-gtk/SpiceSession.html#SpiceSessionClass"> +<ANCHOR id="SpiceSessionMigration" href="spice-gtk/SpiceSession.html#SpiceSessionMigration"> +<ANCHOR id="SPICE-SESSION-MIGRATION-NONE:CAPS" href="spice-gtk/SpiceSession.html#SPICE-SESSION-MIGRATION-NONE:CAPS"> +<ANCHOR id="SPICE-SESSION-MIGRATION-SWITCHING:CAPS" href="spice-gtk/SpiceSession.html#SPICE-SESSION-MIGRATION-SWITCHING:CAPS"> +<ANCHOR id="SPICE-SESSION-MIGRATION-MIGRATING:CAPS" href="spice-gtk/SpiceSession.html#SPICE-SESSION-MIGRATION-MIGRATING:CAPS"> +<ANCHOR id="SPICE-SESSION-MIGRATION-CONNECTING:CAPS" href="spice-gtk/SpiceSession.html#SPICE-SESSION-MIGRATION-CONNECTING:CAPS"> +<ANCHOR id="SpiceSessionVerify" href="spice-gtk/SpiceSession.html#SpiceSessionVerify"> +<ANCHOR id="SPICE-SESSION-VERIFY-PUBKEY:CAPS" href="spice-gtk/SpiceSession.html#SPICE-SESSION-VERIFY-PUBKEY:CAPS"> +<ANCHOR id="SPICE-SESSION-VERIFY-HOSTNAME:CAPS" href="spice-gtk/SpiceSession.html#SPICE-SESSION-VERIFY-HOSTNAME:CAPS"> +<ANCHOR id="SPICE-SESSION-VERIFY-SUBJECT:CAPS" href="spice-gtk/SpiceSession.html#SPICE-SESSION-VERIFY-SUBJECT:CAPS"> +<ANCHOR id="SpiceClientError" href="spice-gtk/SpiceSession.html#SpiceClientError"> +<ANCHOR id="SPICE-CLIENT-ERROR-FAILED:CAPS" href="spice-gtk/SpiceSession.html#SPICE-CLIENT-ERROR-FAILED:CAPS"> +<ANCHOR id="SPICE-CLIENT-ERROR-USB-DEVICE-REJECTED:CAPS" href="spice-gtk/SpiceSession.html#SPICE-CLIENT-ERROR-USB-DEVICE-REJECTED:CAPS"> +<ANCHOR id="SPICE-CLIENT-ERROR-USB-DEVICE-LOST:CAPS" href="spice-gtk/SpiceSession.html#SPICE-CLIENT-ERROR-USB-DEVICE-LOST:CAPS"> +<ANCHOR id="SPICE-CLIENT-ERROR-AUTH-NEEDS-PASSWORD:CAPS" href="spice-gtk/SpiceSession.html#SPICE-CLIENT-ERROR-AUTH-NEEDS-PASSWORD:CAPS"> +<ANCHOR id="SPICE-CLIENT-ERROR-AUTH-NEEDS-PASSWORD-AND-USERNAME:CAPS" href="spice-gtk/SpiceSession.html#SPICE-CLIENT-ERROR-AUTH-NEEDS-PASSWORD-AND-USERNAME:CAPS"> +<ANCHOR id="SPICE-CLIENT-ERROR-USB-SERVICE:CAPS" href="spice-gtk/SpiceSession.html#SPICE-CLIENT-ERROR-USB-SERVICE:CAPS"> +<ANCHOR id="SPICE-CLIENT-ERROR:CAPS" href="spice-gtk/SpiceSession.html#SPICE-CLIENT-ERROR:CAPS"> +<ANCHOR id="SpiceSession.property-details" href="spice-gtk/SpiceSession.html#SpiceSession.property-details"> +<ANCHOR id="SpiceSession--ca" href="spice-gtk/SpiceSession.html#SpiceSession--ca"> +<ANCHOR id="SpiceSession--ca-file" href="spice-gtk/SpiceSession.html#SpiceSession--ca-file"> +<ANCHOR id="SpiceSession--cache-size" href="spice-gtk/SpiceSession.html#SpiceSession--cache-size"> +<ANCHOR id="SpiceSession--cert-subject" href="spice-gtk/SpiceSession.html#SpiceSession--cert-subject"> +<ANCHOR id="SpiceSession--ciphers" href="spice-gtk/SpiceSession.html#SpiceSession--ciphers"> +<ANCHOR id="SpiceSession--client-sockets" href="spice-gtk/SpiceSession.html#SpiceSession--client-sockets"> +<ANCHOR id="SpiceSession--color-depth" href="spice-gtk/SpiceSession.html#SpiceSession--color-depth"> +<ANCHOR id="SpiceSession--disable-effects" href="spice-gtk/SpiceSession.html#SpiceSession--disable-effects"> +<ANCHOR id="SpiceSession--enable-audio" href="spice-gtk/SpiceSession.html#SpiceSession--enable-audio"> +<ANCHOR id="SpiceSession--enable-smartcard" href="spice-gtk/SpiceSession.html#SpiceSession--enable-smartcard"> +<ANCHOR id="SpiceSession--enable-usbredir" href="spice-gtk/SpiceSession.html#SpiceSession--enable-usbredir"> +<ANCHOR id="SpiceSession--glz-window-size" href="spice-gtk/SpiceSession.html#SpiceSession--glz-window-size"> +<ANCHOR id="SpiceSession--host" href="spice-gtk/SpiceSession.html#SpiceSession--host"> +<ANCHOR id="SpiceSession--inhibit-keyboard-grab" href="spice-gtk/SpiceSession.html#SpiceSession--inhibit-keyboard-grab"> +<ANCHOR id="SpiceSession--migration-state" href="spice-gtk/SpiceSession.html#SpiceSession--migration-state"> +<ANCHOR id="SpiceSession--name" href="spice-gtk/SpiceSession.html#SpiceSession--name"> +<ANCHOR id="SpiceSession--password" href="spice-gtk/SpiceSession.html#SpiceSession--password"> +<ANCHOR id="SpiceSession--port" href="spice-gtk/SpiceSession.html#SpiceSession--port"> +<ANCHOR id="SpiceSession--preferred-compression" href="spice-gtk/SpiceSession.html#SpiceSession--preferred-compression"> +<ANCHOR id="SpiceSession--protocol" href="spice-gtk/SpiceSession.html#SpiceSession--protocol"> +<ANCHOR id="SpiceSession--proxy" href="spice-gtk/SpiceSession.html#SpiceSession--proxy"> +<ANCHOR id="SpiceSession--pubkey" href="spice-gtk/SpiceSession.html#SpiceSession--pubkey"> +<ANCHOR id="SpiceSession--read-only" href="spice-gtk/SpiceSession.html#SpiceSession--read-only"> +<ANCHOR id="SpiceSession--secure-channels" href="spice-gtk/SpiceSession.html#SpiceSession--secure-channels"> +<ANCHOR id="SpiceSession--share-dir-ro" href="spice-gtk/SpiceSession.html#SpiceSession--share-dir-ro"> +<ANCHOR id="SpiceSession--shared-dir" href="spice-gtk/SpiceSession.html#SpiceSession--shared-dir"> +<ANCHOR id="SpiceSession--smartcard-certificates" href="spice-gtk/SpiceSession.html#SpiceSession--smartcard-certificates"> +<ANCHOR id="SpiceSession--smartcard-db" href="spice-gtk/SpiceSession.html#SpiceSession--smartcard-db"> +<ANCHOR id="SpiceSession--tls-port" href="spice-gtk/SpiceSession.html#SpiceSession--tls-port"> +<ANCHOR id="SpiceSession--unix-path" href="spice-gtk/SpiceSession.html#SpiceSession--unix-path"> +<ANCHOR id="SpiceSession--uri" href="spice-gtk/SpiceSession.html#SpiceSession--uri"> +<ANCHOR id="SpiceSession--username" href="spice-gtk/SpiceSession.html#SpiceSession--username"> +<ANCHOR id="SpiceSession--uuid" href="spice-gtk/SpiceSession.html#SpiceSession--uuid"> +<ANCHOR id="SpiceSession--verify" href="spice-gtk/SpiceSession.html#SpiceSession--verify"> +<ANCHOR id="SpiceSession.signal-details" href="spice-gtk/SpiceSession.html#SpiceSession.signal-details"> +<ANCHOR id="SpiceSession-channel-destroy" href="spice-gtk/SpiceSession.html#SpiceSession-channel-destroy"> +<ANCHOR id="SpiceSession-channel-new" href="spice-gtk/SpiceSession.html#SpiceSession-channel-new"> +<ANCHOR id="SpiceSession-mm-time-reset" href="spice-gtk/SpiceSession.html#SpiceSession-mm-time-reset"> +<ANCHOR id="SpiceSession.see-also" href="spice-gtk/SpiceSession.html#SpiceSession.see-also"> +<ANCHOR id="SpiceChannel" href="spice-gtk/SpiceChannel.html"> +<ANCHOR id="SpiceChannel.stability-level" href="spice-gtk/SpiceChannel.html#SpiceChannel.stability-level"> +<ANCHOR id="SpiceChannel.functions" href="spice-gtk/SpiceChannel.html#SpiceChannel.functions"> +<ANCHOR id="SpiceChannel.properties" href="spice-gtk/SpiceChannel.html#SpiceChannel.properties"> +<ANCHOR id="SpiceChannel.signals" href="spice-gtk/SpiceChannel.html#SpiceChannel.signals"> +<ANCHOR id="SpiceChannel.other" href="spice-gtk/SpiceChannel.html#SpiceChannel.other"> +<ANCHOR id="SpiceChannel.object-hierarchy" href="spice-gtk/SpiceChannel.html#SpiceChannel.object-hierarchy"> +<ANCHOR id="SpiceChannel.includes" href="spice-gtk/SpiceChannel.html#SpiceChannel.includes"> +<ANCHOR id="SpiceChannel.description" href="spice-gtk/SpiceChannel.html#SpiceChannel.description"> +<ANCHOR id="SpiceChannel.functions_details" href="spice-gtk/SpiceChannel.html#SpiceChannel.functions_details"> +<ANCHOR id="spice-channel-new" href="spice-gtk/SpiceChannel.html#spice-channel-new"> +<ANCHOR id="spice-channel-destroy" href="spice-gtk/SpiceChannel.html#spice-channel-destroy"> +<ANCHOR id="spice-channel-connect" href="spice-gtk/SpiceChannel.html#spice-channel-connect"> +<ANCHOR id="spice-channel-open-fd" href="spice-gtk/SpiceChannel.html#spice-channel-open-fd"> +<ANCHOR id="spice-channel-disconnect" href="spice-gtk/SpiceChannel.html#spice-channel-disconnect"> +<ANCHOR id="spice-channel-test-capability" href="spice-gtk/SpiceChannel.html#spice-channel-test-capability"> +<ANCHOR id="spice-channel-test-common-capability" href="spice-gtk/SpiceChannel.html#spice-channel-test-common-capability"> +<ANCHOR id="spice-channel-type-to-string" href="spice-gtk/SpiceChannel.html#spice-channel-type-to-string"> +<ANCHOR id="spice-channel-string-to-type" href="spice-gtk/SpiceChannel.html#spice-channel-string-to-type"> +<ANCHOR id="spice-channel-set-capability" href="spice-gtk/SpiceChannel.html#spice-channel-set-capability"> +<ANCHOR id="spice-channel-flush-async" href="spice-gtk/SpiceChannel.html#spice-channel-flush-async"> +<ANCHOR id="spice-channel-flush-finish" href="spice-gtk/SpiceChannel.html#spice-channel-flush-finish"> +<ANCHOR id="spice-channel-get-error" href="spice-gtk/SpiceChannel.html#spice-channel-get-error"> +<ANCHOR id="SpiceChannel.other_details" href="spice-gtk/SpiceChannel.html#SpiceChannel.other_details"> +<ANCHOR id="SpiceChannelEvent" href="spice-gtk/SpiceChannel.html#SpiceChannelEvent"> +<ANCHOR id="SPICE-CHANNEL-NONE:CAPS" href="spice-gtk/SpiceChannel.html#SPICE-CHANNEL-NONE:CAPS"> +<ANCHOR id="SPICE-CHANNEL-OPENED:CAPS" href="spice-gtk/SpiceChannel.html#SPICE-CHANNEL-OPENED:CAPS"> +<ANCHOR id="SPICE-CHANNEL-SWITCHING:CAPS" href="spice-gtk/SpiceChannel.html#SPICE-CHANNEL-SWITCHING:CAPS"> +<ANCHOR id="SPICE-CHANNEL-CLOSED:CAPS" href="spice-gtk/SpiceChannel.html#SPICE-CHANNEL-CLOSED:CAPS"> +<ANCHOR id="SPICE-CHANNEL-ERROR-CONNECT:CAPS" href="spice-gtk/SpiceChannel.html#SPICE-CHANNEL-ERROR-CONNECT:CAPS"> +<ANCHOR id="SPICE-CHANNEL-ERROR-TLS:CAPS" href="spice-gtk/SpiceChannel.html#SPICE-CHANNEL-ERROR-TLS:CAPS"> +<ANCHOR id="SPICE-CHANNEL-ERROR-LINK:CAPS" href="spice-gtk/SpiceChannel.html#SPICE-CHANNEL-ERROR-LINK:CAPS"> +<ANCHOR id="SPICE-CHANNEL-ERROR-AUTH:CAPS" href="spice-gtk/SpiceChannel.html#SPICE-CHANNEL-ERROR-AUTH:CAPS"> +<ANCHOR id="SPICE-CHANNEL-ERROR-IO:CAPS" href="spice-gtk/SpiceChannel.html#SPICE-CHANNEL-ERROR-IO:CAPS"> +<ANCHOR id="SpiceChannel-struct" href="spice-gtk/SpiceChannel.html#SpiceChannel-struct"> +<ANCHOR id="SpiceChannelClass" href="spice-gtk/SpiceChannel.html#SpiceChannelClass"> +<ANCHOR id="SpiceChannel.property-details" href="spice-gtk/SpiceChannel.html#SpiceChannel.property-details"> +<ANCHOR id="SpiceChannel--channel-id" href="spice-gtk/SpiceChannel.html#SpiceChannel--channel-id"> +<ANCHOR id="SpiceChannel--channel-type" href="spice-gtk/SpiceChannel.html#SpiceChannel--channel-type"> +<ANCHOR id="SpiceChannel--spice-session" href="spice-gtk/SpiceChannel.html#SpiceChannel--spice-session"> +<ANCHOR id="SpiceChannel--total-read-bytes" href="spice-gtk/SpiceChannel.html#SpiceChannel--total-read-bytes"> +<ANCHOR id="SpiceChannel.signal-details" href="spice-gtk/SpiceChannel.html#SpiceChannel.signal-details"> +<ANCHOR id="SpiceChannel-channel-event" href="spice-gtk/SpiceChannel.html#SpiceChannel-channel-event"> +<ANCHOR id="SpiceChannel-open-fd" href="spice-gtk/SpiceChannel.html#SpiceChannel-open-fd"> +<ANCHOR id="SpiceChannel.see-also" href="spice-gtk/SpiceChannel.html#SpiceChannel.see-also"> +<ANCHOR id="SpiceCursorChannel" href="spice-gtk/SpiceCursorChannel.html"> +<ANCHOR id="SpiceCursorChannel.stability-level" href="spice-gtk/SpiceCursorChannel.html#SpiceCursorChannel.stability-level"> +<ANCHOR id="SpiceCursorChannel.signals" href="spice-gtk/SpiceCursorChannel.html#SpiceCursorChannel.signals"> +<ANCHOR id="SpiceCursorChannel.other" href="spice-gtk/SpiceCursorChannel.html#SpiceCursorChannel.other"> +<ANCHOR id="SpiceCursorChannel.object-hierarchy" href="spice-gtk/SpiceCursorChannel.html#SpiceCursorChannel.object-hierarchy"> +<ANCHOR id="SpiceCursorChannel.includes" href="spice-gtk/SpiceCursorChannel.html#SpiceCursorChannel.includes"> +<ANCHOR id="SpiceCursorChannel.description" href="spice-gtk/SpiceCursorChannel.html#SpiceCursorChannel.description"> +<ANCHOR id="SpiceCursorChannel.functions_details" href="spice-gtk/SpiceCursorChannel.html#SpiceCursorChannel.functions_details"> +<ANCHOR id="SpiceCursorChannel.other_details" href="spice-gtk/SpiceCursorChannel.html#SpiceCursorChannel.other_details"> +<ANCHOR id="SpiceCursorChannel-struct" href="spice-gtk/SpiceCursorChannel.html#SpiceCursorChannel-struct"> +<ANCHOR id="SpiceCursorChannelClass" href="spice-gtk/SpiceCursorChannel.html#SpiceCursorChannelClass"> +<ANCHOR id="SpiceCursorChannel.signal-details" href="spice-gtk/SpiceCursorChannel.html#SpiceCursorChannel.signal-details"> +<ANCHOR id="SpiceCursorChannel-cursor-hide" href="spice-gtk/SpiceCursorChannel.html#SpiceCursorChannel-cursor-hide"> +<ANCHOR id="SpiceCursorChannel-cursor-move" href="spice-gtk/SpiceCursorChannel.html#SpiceCursorChannel-cursor-move"> +<ANCHOR id="SpiceCursorChannel-cursor-reset" href="spice-gtk/SpiceCursorChannel.html#SpiceCursorChannel-cursor-reset"> +<ANCHOR id="SpiceCursorChannel-cursor-set" href="spice-gtk/SpiceCursorChannel.html#SpiceCursorChannel-cursor-set"> +<ANCHOR id="SpiceCursorChannel.see-also" href="spice-gtk/SpiceCursorChannel.html#SpiceCursorChannel.see-also"> +<ANCHOR id="SpiceDisplayChannel" href="spice-gtk/SpiceDisplayChannel.html"> +<ANCHOR id="SpiceDisplayChannel.stability-level" href="spice-gtk/SpiceDisplayChannel.html#SpiceDisplayChannel.stability-level"> +<ANCHOR id="SpiceDisplayChannel.functions" href="spice-gtk/SpiceDisplayChannel.html#SpiceDisplayChannel.functions"> +<ANCHOR id="SpiceDisplayChannel.properties" href="spice-gtk/SpiceDisplayChannel.html#SpiceDisplayChannel.properties"> +<ANCHOR id="SpiceDisplayChannel.signals" href="spice-gtk/SpiceDisplayChannel.html#SpiceDisplayChannel.signals"> +<ANCHOR id="SpiceDisplayChannel.other" href="spice-gtk/SpiceDisplayChannel.html#SpiceDisplayChannel.other"> +<ANCHOR id="SpiceDisplayChannel.object-hierarchy" href="spice-gtk/SpiceDisplayChannel.html#SpiceDisplayChannel.object-hierarchy"> +<ANCHOR id="SpiceDisplayChannel.includes" href="spice-gtk/SpiceDisplayChannel.html#SpiceDisplayChannel.includes"> +<ANCHOR id="SpiceDisplayChannel.description" href="spice-gtk/SpiceDisplayChannel.html#SpiceDisplayChannel.description"> +<ANCHOR id="SpiceDisplayChannel.functions_details" href="spice-gtk/SpiceDisplayChannel.html#SpiceDisplayChannel.functions_details"> +<ANCHOR id="spice-display-get-primary" href="spice-gtk/SpiceDisplayChannel.html#spice-display-get-primary"> +<ANCHOR id="SpiceDisplayChannel.other_details" href="spice-gtk/SpiceDisplayChannel.html#SpiceDisplayChannel.other_details"> +<ANCHOR id="SpiceDisplayChannel-struct" href="spice-gtk/SpiceDisplayChannel.html#SpiceDisplayChannel-struct"> +<ANCHOR id="SpiceDisplayChannelClass" href="spice-gtk/SpiceDisplayChannel.html#SpiceDisplayChannelClass"> +<ANCHOR id="SpiceDisplayChannel.property-details" href="spice-gtk/SpiceDisplayChannel.html#SpiceDisplayChannel.property-details"> +<ANCHOR id="SpiceDisplayChannel--height" href="spice-gtk/SpiceDisplayChannel.html#SpiceDisplayChannel--height"> +<ANCHOR id="SpiceDisplayChannel--monitors" href="spice-gtk/SpiceDisplayChannel.html#SpiceDisplayChannel--monitors"> +<ANCHOR id="SpiceDisplayChannel--monitors-max" href="spice-gtk/SpiceDisplayChannel.html#SpiceDisplayChannel--monitors-max"> +<ANCHOR id="SpiceDisplayChannel--width" href="spice-gtk/SpiceDisplayChannel.html#SpiceDisplayChannel--width"> +<ANCHOR id="SpiceDisplayChannel.signal-details" href="spice-gtk/SpiceDisplayChannel.html#SpiceDisplayChannel.signal-details"> +<ANCHOR id="SpiceDisplayChannel-display-invalidate" href="spice-gtk/SpiceDisplayChannel.html#SpiceDisplayChannel-display-invalidate"> +<ANCHOR id="SpiceDisplayChannel-display-mark" href="spice-gtk/SpiceDisplayChannel.html#SpiceDisplayChannel-display-mark"> +<ANCHOR id="SpiceDisplayChannel-display-primary-create" href="spice-gtk/SpiceDisplayChannel.html#SpiceDisplayChannel-display-primary-create"> +<ANCHOR id="SpiceDisplayChannel-display-primary-destroy" href="spice-gtk/SpiceDisplayChannel.html#SpiceDisplayChannel-display-primary-destroy"> +<ANCHOR id="SpiceDisplayChannel.see-also" href="spice-gtk/SpiceDisplayChannel.html#SpiceDisplayChannel.see-also"> +<ANCHOR id="SpiceInputsChannel" href="spice-gtk/SpiceInputsChannel.html"> +<ANCHOR id="SpiceInputsChannel.stability-level" href="spice-gtk/SpiceInputsChannel.html#SpiceInputsChannel.stability-level"> +<ANCHOR id="SpiceInputsChannel.functions" href="spice-gtk/SpiceInputsChannel.html#SpiceInputsChannel.functions"> +<ANCHOR id="SpiceInputsChannel.properties" href="spice-gtk/SpiceInputsChannel.html#SpiceInputsChannel.properties"> +<ANCHOR id="SpiceInputsChannel.signals" href="spice-gtk/SpiceInputsChannel.html#SpiceInputsChannel.signals"> +<ANCHOR id="SpiceInputsChannel.other" href="spice-gtk/SpiceInputsChannel.html#SpiceInputsChannel.other"> +<ANCHOR id="SpiceInputsChannel.object-hierarchy" href="spice-gtk/SpiceInputsChannel.html#SpiceInputsChannel.object-hierarchy"> +<ANCHOR id="SpiceInputsChannel.includes" href="spice-gtk/SpiceInputsChannel.html#SpiceInputsChannel.includes"> +<ANCHOR id="SpiceInputsChannel.description" href="spice-gtk/SpiceInputsChannel.html#SpiceInputsChannel.description"> +<ANCHOR id="SpiceInputsChannel.functions_details" href="spice-gtk/SpiceInputsChannel.html#SpiceInputsChannel.functions_details"> +<ANCHOR id="spice-inputs-motion" href="spice-gtk/SpiceInputsChannel.html#spice-inputs-motion"> +<ANCHOR id="spice-inputs-position" href="spice-gtk/SpiceInputsChannel.html#spice-inputs-position"> +<ANCHOR id="spice-inputs-button-press" href="spice-gtk/SpiceInputsChannel.html#spice-inputs-button-press"> +<ANCHOR id="spice-inputs-button-release" href="spice-gtk/SpiceInputsChannel.html#spice-inputs-button-release"> +<ANCHOR id="spice-inputs-key-press" href="spice-gtk/SpiceInputsChannel.html#spice-inputs-key-press"> +<ANCHOR id="spice-inputs-key-press-and-release" href="spice-gtk/SpiceInputsChannel.html#spice-inputs-key-press-and-release"> +<ANCHOR id="spice-inputs-key-release" href="spice-gtk/SpiceInputsChannel.html#spice-inputs-key-release"> +<ANCHOR id="spice-inputs-set-key-locks" href="spice-gtk/SpiceInputsChannel.html#spice-inputs-set-key-locks"> +<ANCHOR id="SpiceInputsChannel.other_details" href="spice-gtk/SpiceInputsChannel.html#SpiceInputsChannel.other_details"> +<ANCHOR id="SpiceInputsChannel-struct" href="spice-gtk/SpiceInputsChannel.html#SpiceInputsChannel-struct"> +<ANCHOR id="SpiceInputsChannelClass" href="spice-gtk/SpiceInputsChannel.html#SpiceInputsChannelClass"> +<ANCHOR id="SpiceInputsLock" href="spice-gtk/SpiceInputsChannel.html#SpiceInputsLock"> +<ANCHOR id="SPICE-INPUTS-SCROLL-LOCK:CAPS" href="spice-gtk/SpiceInputsChannel.html#SPICE-INPUTS-SCROLL-LOCK:CAPS"> +<ANCHOR id="SPICE-INPUTS-NUM-LOCK:CAPS" href="spice-gtk/SpiceInputsChannel.html#SPICE-INPUTS-NUM-LOCK:CAPS"> +<ANCHOR id="SPICE-INPUTS-CAPS-LOCK:CAPS" href="spice-gtk/SpiceInputsChannel.html#SPICE-INPUTS-CAPS-LOCK:CAPS"> +<ANCHOR id="SpiceInputsChannel.property-details" href="spice-gtk/SpiceInputsChannel.html#SpiceInputsChannel.property-details"> +<ANCHOR id="SpiceInputsChannel--key-modifiers" href="spice-gtk/SpiceInputsChannel.html#SpiceInputsChannel--key-modifiers"> +<ANCHOR id="SpiceInputsChannel.signal-details" href="spice-gtk/SpiceInputsChannel.html#SpiceInputsChannel.signal-details"> +<ANCHOR id="SpiceInputsChannel-inputs-modifiers" href="spice-gtk/SpiceInputsChannel.html#SpiceInputsChannel-inputs-modifiers"> +<ANCHOR id="SpiceInputsChannel.see-also" href="spice-gtk/SpiceInputsChannel.html#SpiceInputsChannel.see-also"> +<ANCHOR id="SpiceMainChannel" href="spice-gtk/SpiceMainChannel.html"> +<ANCHOR id="SpiceMainChannel.stability-level" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel.stability-level"> +<ANCHOR id="SpiceMainChannel.functions" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel.functions"> +<ANCHOR id="SpiceMainChannel.properties" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel.properties"> +<ANCHOR id="SpiceMainChannel.signals" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel.signals"> +<ANCHOR id="SpiceMainChannel.other" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel.other"> +<ANCHOR id="SpiceMainChannel.object-hierarchy" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel.object-hierarchy"> +<ANCHOR id="SpiceMainChannel.includes" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel.includes"> +<ANCHOR id="SpiceMainChannel.description" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel.description"> +<ANCHOR id="SpiceMainChannel.functions_details" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel.functions_details"> +<ANCHOR id="spice-main-set-display" href="spice-gtk/SpiceMainChannel.html#spice-main-set-display"> +<ANCHOR id="spice-main-set-display-enabled" href="spice-gtk/SpiceMainChannel.html#spice-main-set-display-enabled"> +<ANCHOR id="spice-main-update-display" href="spice-gtk/SpiceMainChannel.html#spice-main-update-display"> +<ANCHOR id="spice-main-update-display-enabled" href="spice-gtk/SpiceMainChannel.html#spice-main-update-display-enabled"> +<ANCHOR id="spice-main-send-monitor-config" href="spice-gtk/SpiceMainChannel.html#spice-main-send-monitor-config"> +<ANCHOR id="spice-main-agent-test-capability" href="spice-gtk/SpiceMainChannel.html#spice-main-agent-test-capability"> +<ANCHOR id="spice-main-clipboard-selection-grab" href="spice-gtk/SpiceMainChannel.html#spice-main-clipboard-selection-grab"> +<ANCHOR id="spice-main-clipboard-selection-notify" href="spice-gtk/SpiceMainChannel.html#spice-main-clipboard-selection-notify"> +<ANCHOR id="spice-main-clipboard-selection-release" href="spice-gtk/SpiceMainChannel.html#spice-main-clipboard-selection-release"> +<ANCHOR id="spice-main-clipboard-selection-request" href="spice-gtk/SpiceMainChannel.html#spice-main-clipboard-selection-request"> +<ANCHOR id="spice-main-clipboard-grab" href="spice-gtk/SpiceMainChannel.html#spice-main-clipboard-grab"> +<ANCHOR id="spice-main-clipboard-release" href="spice-gtk/SpiceMainChannel.html#spice-main-clipboard-release"> +<ANCHOR id="spice-main-clipboard-notify" href="spice-gtk/SpiceMainChannel.html#spice-main-clipboard-notify"> +<ANCHOR id="spice-main-clipboard-request" href="spice-gtk/SpiceMainChannel.html#spice-main-clipboard-request"> +<ANCHOR id="spice-main-file-copy-async" href="spice-gtk/SpiceMainChannel.html#spice-main-file-copy-async"> +<ANCHOR id="spice-main-file-copy-finish" href="spice-gtk/SpiceMainChannel.html#spice-main-file-copy-finish"> +<ANCHOR id="SpiceMainChannel.other_details" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel.other_details"> +<ANCHOR id="SpiceMainChannel-struct" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel-struct"> +<ANCHOR id="SpiceMainChannelClass" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannelClass"> +<ANCHOR id="SpiceMainChannel.property-details" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel.property-details"> +<ANCHOR id="SpiceMainChannel--agent-caps-0" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel--agent-caps-0"> +<ANCHOR id="SpiceMainChannel--agent-connected" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel--agent-connected"> +<ANCHOR id="SpiceMainChannel--color-depth" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel--color-depth"> +<ANCHOR id="SpiceMainChannel--disable-animation" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel--disable-animation"> +<ANCHOR id="SpiceMainChannel--disable-display-align" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel--disable-display-align"> +<ANCHOR id="SpiceMainChannel--disable-display-position" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel--disable-display-position"> +<ANCHOR id="SpiceMainChannel--disable-font-smooth" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel--disable-font-smooth"> +<ANCHOR id="SpiceMainChannel--disable-wallpaper" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel--disable-wallpaper"> +<ANCHOR id="SpiceMainChannel--max-clipboard" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel--max-clipboard"> +<ANCHOR id="SpiceMainChannel--mouse-mode" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel--mouse-mode"> +<ANCHOR id="SpiceMainChannel.signal-details" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel.signal-details"> +<ANCHOR id="SpiceMainChannel-main-agent-update" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel-main-agent-update"> +<ANCHOR id="SpiceMainChannel-main-clipboard" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel-main-clipboard"> +<ANCHOR id="SpiceMainChannel-main-clipboard-grab" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel-main-clipboard-grab"> +<ANCHOR id="SpiceMainChannel-main-clipboard-release" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel-main-clipboard-release"> +<ANCHOR id="SpiceMainChannel-main-clipboard-request" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel-main-clipboard-request"> +<ANCHOR id="SpiceMainChannel-main-clipboard-selection" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel-main-clipboard-selection"> +<ANCHOR id="SpiceMainChannel-main-clipboard-selection-grab" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel-main-clipboard-selection-grab"> +<ANCHOR id="SpiceMainChannel-main-clipboard-selection-release" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel-main-clipboard-selection-release"> +<ANCHOR id="SpiceMainChannel-main-clipboard-selection-request" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel-main-clipboard-selection-request"> +<ANCHOR id="SpiceMainChannel-main-mouse-update" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel-main-mouse-update"> +<ANCHOR id="SpiceMainChannel-migration-started" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel-migration-started"> +<ANCHOR id="SpiceMainChannel-new-file-transfer" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel-new-file-transfer"> +<ANCHOR id="SpiceMainChannel.see-also" href="spice-gtk/SpiceMainChannel.html#SpiceMainChannel.see-also"> +<ANCHOR id="SpicePlaybackChannel" href="spice-gtk/SpicePlaybackChannel.html"> +<ANCHOR id="SpicePlaybackChannel.stability-level" href="spice-gtk/SpicePlaybackChannel.html#SpicePlaybackChannel.stability-level"> +<ANCHOR id="SpicePlaybackChannel.functions" href="spice-gtk/SpicePlaybackChannel.html#SpicePlaybackChannel.functions"> +<ANCHOR id="SpicePlaybackChannel.properties" href="spice-gtk/SpicePlaybackChannel.html#SpicePlaybackChannel.properties"> +<ANCHOR id="SpicePlaybackChannel.signals" href="spice-gtk/SpicePlaybackChannel.html#SpicePlaybackChannel.signals"> +<ANCHOR id="SpicePlaybackChannel.other" href="spice-gtk/SpicePlaybackChannel.html#SpicePlaybackChannel.other"> +<ANCHOR id="SpicePlaybackChannel.object-hierarchy" href="spice-gtk/SpicePlaybackChannel.html#SpicePlaybackChannel.object-hierarchy"> +<ANCHOR id="SpicePlaybackChannel.includes" href="spice-gtk/SpicePlaybackChannel.html#SpicePlaybackChannel.includes"> +<ANCHOR id="SpicePlaybackChannel.description" href="spice-gtk/SpicePlaybackChannel.html#SpicePlaybackChannel.description"> +<ANCHOR id="SpicePlaybackChannel.functions_details" href="spice-gtk/SpicePlaybackChannel.html#SpicePlaybackChannel.functions_details"> +<ANCHOR id="spice-playback-channel-set-delay" href="spice-gtk/SpicePlaybackChannel.html#spice-playback-channel-set-delay"> +<ANCHOR id="SpicePlaybackChannel.other_details" href="spice-gtk/SpicePlaybackChannel.html#SpicePlaybackChannel.other_details"> +<ANCHOR id="SpicePlaybackChannel-struct" href="spice-gtk/SpicePlaybackChannel.html#SpicePlaybackChannel-struct"> +<ANCHOR id="SpicePlaybackChannelClass" href="spice-gtk/SpicePlaybackChannel.html#SpicePlaybackChannelClass"> +<ANCHOR id="SpicePlaybackChannel.property-details" href="spice-gtk/SpicePlaybackChannel.html#SpicePlaybackChannel.property-details"> +<ANCHOR id="SpicePlaybackChannel--min-latency" href="spice-gtk/SpicePlaybackChannel.html#SpicePlaybackChannel--min-latency"> +<ANCHOR id="SpicePlaybackChannel--mute" href="spice-gtk/SpicePlaybackChannel.html#SpicePlaybackChannel--mute"> +<ANCHOR id="SpicePlaybackChannel--nchannels" href="spice-gtk/SpicePlaybackChannel.html#SpicePlaybackChannel--nchannels"> +<ANCHOR id="SpicePlaybackChannel--volume" href="spice-gtk/SpicePlaybackChannel.html#SpicePlaybackChannel--volume"> +<ANCHOR id="SpicePlaybackChannel.signal-details" href="spice-gtk/SpicePlaybackChannel.html#SpicePlaybackChannel.signal-details"> +<ANCHOR id="SpicePlaybackChannel-playback-data" href="spice-gtk/SpicePlaybackChannel.html#SpicePlaybackChannel-playback-data"> +<ANCHOR id="SpicePlaybackChannel-playback-get-delay" href="spice-gtk/SpicePlaybackChannel.html#SpicePlaybackChannel-playback-get-delay"> +<ANCHOR id="SpicePlaybackChannel-playback-start" href="spice-gtk/SpicePlaybackChannel.html#SpicePlaybackChannel-playback-start"> +<ANCHOR id="SpicePlaybackChannel-playback-stop" href="spice-gtk/SpicePlaybackChannel.html#SpicePlaybackChannel-playback-stop"> +<ANCHOR id="SpicePlaybackChannel.see-also" href="spice-gtk/SpicePlaybackChannel.html#SpicePlaybackChannel.see-also"> +<ANCHOR id="SpiceRecordChannel" href="spice-gtk/SpiceRecordChannel.html"> +<ANCHOR id="SpiceRecordChannel.stability-level" href="spice-gtk/SpiceRecordChannel.html#SpiceRecordChannel.stability-level"> +<ANCHOR id="SpiceRecordChannel.functions" href="spice-gtk/SpiceRecordChannel.html#SpiceRecordChannel.functions"> +<ANCHOR id="SpiceRecordChannel.properties" href="spice-gtk/SpiceRecordChannel.html#SpiceRecordChannel.properties"> +<ANCHOR id="SpiceRecordChannel.signals" href="spice-gtk/SpiceRecordChannel.html#SpiceRecordChannel.signals"> +<ANCHOR id="SpiceRecordChannel.other" href="spice-gtk/SpiceRecordChannel.html#SpiceRecordChannel.other"> +<ANCHOR id="SpiceRecordChannel.object-hierarchy" href="spice-gtk/SpiceRecordChannel.html#SpiceRecordChannel.object-hierarchy"> +<ANCHOR id="SpiceRecordChannel.includes" href="spice-gtk/SpiceRecordChannel.html#SpiceRecordChannel.includes"> +<ANCHOR id="SpiceRecordChannel.description" href="spice-gtk/SpiceRecordChannel.html#SpiceRecordChannel.description"> +<ANCHOR id="SpiceRecordChannel.functions_details" href="spice-gtk/SpiceRecordChannel.html#SpiceRecordChannel.functions_details"> +<ANCHOR id="spice-record-send-data" href="spice-gtk/SpiceRecordChannel.html#spice-record-send-data"> +<ANCHOR id="SpiceRecordChannel.other_details" href="spice-gtk/SpiceRecordChannel.html#SpiceRecordChannel.other_details"> +<ANCHOR id="SpiceRecordChannel-struct" href="spice-gtk/SpiceRecordChannel.html#SpiceRecordChannel-struct"> +<ANCHOR id="SpiceRecordChannelClass" href="spice-gtk/SpiceRecordChannel.html#SpiceRecordChannelClass"> +<ANCHOR id="SpiceRecordChannel.property-details" href="spice-gtk/SpiceRecordChannel.html#SpiceRecordChannel.property-details"> +<ANCHOR id="SpiceRecordChannel--mute" href="spice-gtk/SpiceRecordChannel.html#SpiceRecordChannel--mute"> +<ANCHOR id="SpiceRecordChannel--nchannels" href="spice-gtk/SpiceRecordChannel.html#SpiceRecordChannel--nchannels"> +<ANCHOR id="SpiceRecordChannel--volume" href="spice-gtk/SpiceRecordChannel.html#SpiceRecordChannel--volume"> +<ANCHOR id="SpiceRecordChannel.signal-details" href="spice-gtk/SpiceRecordChannel.html#SpiceRecordChannel.signal-details"> +<ANCHOR id="SpiceRecordChannel-record-start" href="spice-gtk/SpiceRecordChannel.html#SpiceRecordChannel-record-start"> +<ANCHOR id="SpiceRecordChannel-record-stop" href="spice-gtk/SpiceRecordChannel.html#SpiceRecordChannel-record-stop"> +<ANCHOR id="SpiceRecordChannel.see-also" href="spice-gtk/SpiceRecordChannel.html#SpiceRecordChannel.see-also"> +<ANCHOR id="SpiceSmartcardChannel" href="spice-gtk/SpiceSmartcardChannel.html"> +<ANCHOR id="SpiceSmartcardChannel.stability-level" href="spice-gtk/SpiceSmartcardChannel.html#SpiceSmartcardChannel.stability-level"> +<ANCHOR id="SpiceSmartcardChannel.other" href="spice-gtk/SpiceSmartcardChannel.html#SpiceSmartcardChannel.other"> +<ANCHOR id="SpiceSmartcardChannel.object-hierarchy" href="spice-gtk/SpiceSmartcardChannel.html#SpiceSmartcardChannel.object-hierarchy"> +<ANCHOR id="SpiceSmartcardChannel.includes" href="spice-gtk/SpiceSmartcardChannel.html#SpiceSmartcardChannel.includes"> +<ANCHOR id="SpiceSmartcardChannel.description" href="spice-gtk/SpiceSmartcardChannel.html#SpiceSmartcardChannel.description"> +<ANCHOR id="SpiceSmartcardChannel.functions_details" href="spice-gtk/SpiceSmartcardChannel.html#SpiceSmartcardChannel.functions_details"> +<ANCHOR id="SpiceSmartcardChannel.other_details" href="spice-gtk/SpiceSmartcardChannel.html#SpiceSmartcardChannel.other_details"> +<ANCHOR id="SpiceSmartcardChannel-struct" href="spice-gtk/SpiceSmartcardChannel.html#SpiceSmartcardChannel-struct"> +<ANCHOR id="SpiceSmartcardChannelClass" href="spice-gtk/SpiceSmartcardChannel.html#SpiceSmartcardChannelClass"> +<ANCHOR id="SpiceSmartcardChannel.see-also" href="spice-gtk/SpiceSmartcardChannel.html#SpiceSmartcardChannel.see-also"> +<ANCHOR id="SpiceUsbredirChannel" href="spice-gtk/SpiceUsbredirChannel.html"> +<ANCHOR id="SpiceUsbredirChannel.stability-level" href="spice-gtk/SpiceUsbredirChannel.html#SpiceUsbredirChannel.stability-level"> +<ANCHOR id="SpiceUsbredirChannel.other" href="spice-gtk/SpiceUsbredirChannel.html#SpiceUsbredirChannel.other"> +<ANCHOR id="SpiceUsbredirChannel.object-hierarchy" href="spice-gtk/SpiceUsbredirChannel.html#SpiceUsbredirChannel.object-hierarchy"> +<ANCHOR id="SpiceUsbredirChannel.includes" href="spice-gtk/SpiceUsbredirChannel.html#SpiceUsbredirChannel.includes"> +<ANCHOR id="SpiceUsbredirChannel.description" href="spice-gtk/SpiceUsbredirChannel.html#SpiceUsbredirChannel.description"> +<ANCHOR id="SpiceUsbredirChannel.functions_details" href="spice-gtk/SpiceUsbredirChannel.html#SpiceUsbredirChannel.functions_details"> +<ANCHOR id="SpiceUsbredirChannel.other_details" href="spice-gtk/SpiceUsbredirChannel.html#SpiceUsbredirChannel.other_details"> +<ANCHOR id="SpiceUsbredirChannel-struct" href="spice-gtk/SpiceUsbredirChannel.html#SpiceUsbredirChannel-struct"> +<ANCHOR id="SpiceUsbredirChannelClass" href="spice-gtk/SpiceUsbredirChannel.html#SpiceUsbredirChannelClass"> +<ANCHOR id="SpicePortChannel" href="spice-gtk/SpicePortChannel.html"> +<ANCHOR id="SpicePortChannel.stability-level" href="spice-gtk/SpicePortChannel.html#SpicePortChannel.stability-level"> +<ANCHOR id="SpicePortChannel.functions" href="spice-gtk/SpicePortChannel.html#SpicePortChannel.functions"> +<ANCHOR id="SpicePortChannel.properties" href="spice-gtk/SpicePortChannel.html#SpicePortChannel.properties"> +<ANCHOR id="SpicePortChannel.signals" href="spice-gtk/SpicePortChannel.html#SpicePortChannel.signals"> +<ANCHOR id="SpicePortChannel.other" href="spice-gtk/SpicePortChannel.html#SpicePortChannel.other"> +<ANCHOR id="SpicePortChannel.object-hierarchy" href="spice-gtk/SpicePortChannel.html#SpicePortChannel.object-hierarchy"> +<ANCHOR id="SpicePortChannel.includes" href="spice-gtk/SpicePortChannel.html#SpicePortChannel.includes"> +<ANCHOR id="SpicePortChannel.description" href="spice-gtk/SpicePortChannel.html#SpicePortChannel.description"> +<ANCHOR id="SpicePortChannel.functions_details" href="spice-gtk/SpicePortChannel.html#SpicePortChannel.functions_details"> +<ANCHOR id="spice-port-event" href="spice-gtk/SpicePortChannel.html#spice-port-event"> +<ANCHOR id="spice-port-write-async" href="spice-gtk/SpicePortChannel.html#spice-port-write-async"> +<ANCHOR id="spice-port-write-finish" href="spice-gtk/SpicePortChannel.html#spice-port-write-finish"> +<ANCHOR id="SpicePortChannel.other_details" href="spice-gtk/SpicePortChannel.html#SpicePortChannel.other_details"> +<ANCHOR id="SpicePortChannel-struct" href="spice-gtk/SpicePortChannel.html#SpicePortChannel-struct"> +<ANCHOR id="SpicePortChannelClass" href="spice-gtk/SpicePortChannel.html#SpicePortChannelClass"> +<ANCHOR id="SpicePortChannel.property-details" href="spice-gtk/SpicePortChannel.html#SpicePortChannel.property-details"> +<ANCHOR id="SpicePortChannel--port-name" href="spice-gtk/SpicePortChannel.html#SpicePortChannel--port-name"> +<ANCHOR id="SpicePortChannel--port-opened" href="spice-gtk/SpicePortChannel.html#SpicePortChannel--port-opened"> +<ANCHOR id="SpicePortChannel.signal-details" href="spice-gtk/SpicePortChannel.html#SpicePortChannel.signal-details"> +<ANCHOR id="SpicePortChannel-port-data" href="spice-gtk/SpicePortChannel.html#SpicePortChannel-port-data"> +<ANCHOR id="SpicePortChannel-port-event" href="spice-gtk/SpicePortChannel.html#SpicePortChannel-port-event"> +<ANCHOR id="SpicePortChannel.see-also" href="spice-gtk/SpicePortChannel.html#SpicePortChannel.see-also"> +<ANCHOR id="SpiceWebdavChannel" href="spice-gtk/SpiceWebdavChannel.html"> +<ANCHOR id="SpiceWebdavChannel.stability-level" href="spice-gtk/SpiceWebdavChannel.html#SpiceWebdavChannel.stability-level"> +<ANCHOR id="SpiceWebdavChannel.other" href="spice-gtk/SpiceWebdavChannel.html#SpiceWebdavChannel.other"> +<ANCHOR id="SpiceWebdavChannel.object-hierarchy" href="spice-gtk/SpiceWebdavChannel.html#SpiceWebdavChannel.object-hierarchy"> +<ANCHOR id="SpiceWebdavChannel.includes" href="spice-gtk/SpiceWebdavChannel.html#SpiceWebdavChannel.includes"> +<ANCHOR id="SpiceWebdavChannel.description" href="spice-gtk/SpiceWebdavChannel.html#SpiceWebdavChannel.description"> +<ANCHOR id="SpiceWebdavChannel.functions_details" href="spice-gtk/SpiceWebdavChannel.html#SpiceWebdavChannel.functions_details"> +<ANCHOR id="SpiceWebdavChannel.other_details" href="spice-gtk/SpiceWebdavChannel.html#SpiceWebdavChannel.other_details"> +<ANCHOR id="SpiceWebdavChannel-struct" href="spice-gtk/SpiceWebdavChannel.html#SpiceWebdavChannel-struct"> +<ANCHOR id="SpiceWebdavChannelClass" href="spice-gtk/SpiceWebdavChannel.html#SpiceWebdavChannelClass"> +<ANCHOR id="SpiceWebdavChannel.see-also" href="spice-gtk/SpiceWebdavChannel.html#SpiceWebdavChannel.see-also"> +<ANCHOR id="SpiceGtkSession" href="spice-gtk/SpiceGtkSession.html"> +<ANCHOR id="SpiceGtkSession.stability-level" href="spice-gtk/SpiceGtkSession.html#SpiceGtkSession.stability-level"> +<ANCHOR id="SpiceGtkSession.functions" href="spice-gtk/SpiceGtkSession.html#SpiceGtkSession.functions"> +<ANCHOR id="SpiceGtkSession.properties" href="spice-gtk/SpiceGtkSession.html#SpiceGtkSession.properties"> +<ANCHOR id="SpiceGtkSession.other" href="spice-gtk/SpiceGtkSession.html#SpiceGtkSession.other"> +<ANCHOR id="SpiceGtkSession.object-hierarchy" href="spice-gtk/SpiceGtkSession.html#SpiceGtkSession.object-hierarchy"> +<ANCHOR id="SpiceGtkSession.includes" href="spice-gtk/SpiceGtkSession.html#SpiceGtkSession.includes"> +<ANCHOR id="SpiceGtkSession.description" href="spice-gtk/SpiceGtkSession.html#SpiceGtkSession.description"> +<ANCHOR id="SpiceGtkSession.functions_details" href="spice-gtk/SpiceGtkSession.html#SpiceGtkSession.functions_details"> +<ANCHOR id="spice-gtk-session-get" href="spice-gtk/SpiceGtkSession.html#spice-gtk-session-get"> +<ANCHOR id="spice-gtk-session-copy-to-guest" href="spice-gtk/SpiceGtkSession.html#spice-gtk-session-copy-to-guest"> +<ANCHOR id="spice-gtk-session-paste-from-guest" href="spice-gtk/SpiceGtkSession.html#spice-gtk-session-paste-from-guest"> +<ANCHOR id="SpiceGtkSession.other_details" href="spice-gtk/SpiceGtkSession.html#SpiceGtkSession.other_details"> +<ANCHOR id="SpiceGtkSession-struct" href="spice-gtk/SpiceGtkSession.html#SpiceGtkSession-struct"> +<ANCHOR id="SpiceGtkSessionClass" href="spice-gtk/SpiceGtkSession.html#SpiceGtkSessionClass"> +<ANCHOR id="SpiceGtkSession.property-details" href="spice-gtk/SpiceGtkSession.html#SpiceGtkSession.property-details"> +<ANCHOR id="SpiceGtkSession--auto-clipboard" href="spice-gtk/SpiceGtkSession.html#SpiceGtkSession--auto-clipboard"> +<ANCHOR id="SpiceGtkSession--auto-usbredir" href="spice-gtk/SpiceGtkSession.html#SpiceGtkSession--auto-usbredir"> +<ANCHOR id="SpiceGtkSession--pointer-grabbed" href="spice-gtk/SpiceGtkSession.html#SpiceGtkSession--pointer-grabbed"> +<ANCHOR id="SpiceGtkSession--session" href="spice-gtk/SpiceGtkSession.html#SpiceGtkSession--session"> +<ANCHOR id="SpiceGtkSession.see-also" href="spice-gtk/SpiceGtkSession.html#SpiceGtkSession.see-also"> +<ANCHOR id="SpiceDisplay" href="spice-gtk/SpiceDisplay.html"> +<ANCHOR id="SpiceDisplay.stability-level" href="spice-gtk/SpiceDisplay.html#SpiceDisplay.stability-level"> +<ANCHOR id="SpiceDisplay.functions" href="spice-gtk/SpiceDisplay.html#SpiceDisplay.functions"> +<ANCHOR id="SpiceDisplay.properties" href="spice-gtk/SpiceDisplay.html#SpiceDisplay.properties"> +<ANCHOR id="SpiceDisplay.signals" href="spice-gtk/SpiceDisplay.html#SpiceDisplay.signals"> +<ANCHOR id="SpiceGrabSequence" href="spice-gtk/SpiceDisplay.html#SpiceGrabSequence"> +<ANCHOR id="SpiceDisplay.other" href="spice-gtk/SpiceDisplay.html#SpiceDisplay.other"> +<ANCHOR id="SpiceDisplay.object-hierarchy" href="spice-gtk/SpiceDisplay.html#SpiceDisplay.object-hierarchy"> +<ANCHOR id="SpiceDisplay.implemented-interfaces" href="spice-gtk/SpiceDisplay.html#SpiceDisplay.implemented-interfaces"> +<ANCHOR id="SpiceDisplay.includes" href="spice-gtk/SpiceDisplay.html#SpiceDisplay.includes"> +<ANCHOR id="SpiceDisplay.description" href="spice-gtk/SpiceDisplay.html#SpiceDisplay.description"> +<ANCHOR id="SpiceDisplay.functions_details" href="spice-gtk/SpiceDisplay.html#SpiceDisplay.functions_details"> +<ANCHOR id="spice-display-new" href="spice-gtk/SpiceDisplay.html#spice-display-new"> +<ANCHOR id="spice-display-new-with-monitor" href="spice-gtk/SpiceDisplay.html#spice-display-new-with-monitor"> +<ANCHOR id="spice-display-mouse-ungrab" href="spice-gtk/SpiceDisplay.html#spice-display-mouse-ungrab"> +<ANCHOR id="spice-display-copy-to-guest" href="spice-gtk/SpiceDisplay.html#spice-display-copy-to-guest"> +<ANCHOR id="spice-display-paste-from-guest" href="spice-gtk/SpiceDisplay.html#spice-display-paste-from-guest"> +<ANCHOR id="spice-display-set-grab-keys" href="spice-gtk/SpiceDisplay.html#spice-display-set-grab-keys"> +<ANCHOR id="spice-display-get-grab-keys" href="spice-gtk/SpiceDisplay.html#spice-display-get-grab-keys"> +<ANCHOR id="spice-display-send-keys" href="spice-gtk/SpiceDisplay.html#spice-display-send-keys"> +<ANCHOR id="spice-display-get-pixbuf" href="spice-gtk/SpiceDisplay.html#spice-display-get-pixbuf"> +<ANCHOR id="spice-grab-sequence-new" href="spice-gtk/SpiceDisplay.html#spice-grab-sequence-new"> +<ANCHOR id="spice-grab-sequence-new-from-string" href="spice-gtk/SpiceDisplay.html#spice-grab-sequence-new-from-string"> +<ANCHOR id="spice-grab-sequence-copy" href="spice-gtk/SpiceDisplay.html#spice-grab-sequence-copy"> +<ANCHOR id="spice-grab-sequence-free" href="spice-gtk/SpiceDisplay.html#spice-grab-sequence-free"> +<ANCHOR id="spice-grab-sequence-as-string" href="spice-gtk/SpiceDisplay.html#spice-grab-sequence-as-string"> +<ANCHOR id="SpiceDisplay.other_details" href="spice-gtk/SpiceDisplay.html#SpiceDisplay.other_details"> +<ANCHOR id="SpiceDisplay-struct" href="spice-gtk/SpiceDisplay.html#SpiceDisplay-struct"> +<ANCHOR id="SpiceDisplayClass" href="spice-gtk/SpiceDisplay.html#SpiceDisplayClass"> +<ANCHOR id="SpiceDisplayKeyEvent" href="spice-gtk/SpiceDisplay.html#SpiceDisplayKeyEvent"> +<ANCHOR id="SPICE-DISPLAY-KEY-EVENT-PRESS:CAPS" href="spice-gtk/SpiceDisplay.html#SPICE-DISPLAY-KEY-EVENT-PRESS:CAPS"> +<ANCHOR id="SPICE-DISPLAY-KEY-EVENT-RELEASE:CAPS" href="spice-gtk/SpiceDisplay.html#SPICE-DISPLAY-KEY-EVENT-RELEASE:CAPS"> +<ANCHOR id="SPICE-DISPLAY-KEY-EVENT-CLICK:CAPS" href="spice-gtk/SpiceDisplay.html#SPICE-DISPLAY-KEY-EVENT-CLICK:CAPS"> +<ANCHOR id="SpiceGrabSequence-struct" href="spice-gtk/SpiceDisplay.html#SpiceGrabSequence-struct"> +<ANCHOR id="SpiceDisplay.property-details" href="spice-gtk/SpiceDisplay.html#SpiceDisplay.property-details"> +<ANCHOR id="SpiceDisplay--auto-clipboard" href="spice-gtk/SpiceDisplay.html#SpiceDisplay--auto-clipboard"> +<ANCHOR id="SpiceDisplay--channel-id" href="spice-gtk/SpiceDisplay.html#SpiceDisplay--channel-id"> +<ANCHOR id="SpiceDisplay--disable-inputs" href="spice-gtk/SpiceDisplay.html#SpiceDisplay--disable-inputs"> +<ANCHOR id="SpiceDisplay--grab-keyboard" href="spice-gtk/SpiceDisplay.html#SpiceDisplay--grab-keyboard"> +<ANCHOR id="SpiceDisplay--grab-mouse" href="spice-gtk/SpiceDisplay.html#SpiceDisplay--grab-mouse"> +<ANCHOR id="SpiceDisplay--keypress-delay" href="spice-gtk/SpiceDisplay.html#SpiceDisplay--keypress-delay"> +<ANCHOR id="SpiceDisplay--monitor-id" href="spice-gtk/SpiceDisplay.html#SpiceDisplay--monitor-id"> +<ANCHOR id="SpiceDisplay--only-downscale" href="spice-gtk/SpiceDisplay.html#SpiceDisplay--only-downscale"> +<ANCHOR id="SpiceDisplay--ready" href="spice-gtk/SpiceDisplay.html#SpiceDisplay--ready"> +<ANCHOR id="SpiceDisplay--resize-guest" href="spice-gtk/SpiceDisplay.html#SpiceDisplay--resize-guest"> +<ANCHOR id="SpiceDisplay--scaling" href="spice-gtk/SpiceDisplay.html#SpiceDisplay--scaling"> +<ANCHOR id="SpiceDisplay--session" href="spice-gtk/SpiceDisplay.html#SpiceDisplay--session"> +<ANCHOR id="SpiceDisplay--zoom-level" href="spice-gtk/SpiceDisplay.html#SpiceDisplay--zoom-level"> +<ANCHOR id="SpiceDisplay.signal-details" href="spice-gtk/SpiceDisplay.html#SpiceDisplay.signal-details"> +<ANCHOR id="SpiceDisplay-grab-keys-pressed" href="spice-gtk/SpiceDisplay.html#SpiceDisplay-grab-keys-pressed"> +<ANCHOR id="SpiceDisplay-keyboard-grab" href="spice-gtk/SpiceDisplay.html#SpiceDisplay-keyboard-grab"> +<ANCHOR id="SpiceDisplay-mouse-grab" href="spice-gtk/SpiceDisplay.html#SpiceDisplay-mouse-grab"> +<ANCHOR id="SpiceUsbDeviceWidget" href="spice-gtk/SpiceUsbDeviceWidget.html"> +<ANCHOR id="SpiceUsbDeviceWidget.stability-level" href="spice-gtk/SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget.stability-level"> +<ANCHOR id="SpiceUsbDeviceWidget.functions" href="spice-gtk/SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget.functions"> +<ANCHOR id="SpiceUsbDeviceWidget.properties" href="spice-gtk/SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget.properties"> +<ANCHOR id="SpiceUsbDeviceWidget.signals" href="spice-gtk/SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget.signals"> +<ANCHOR id="SpiceUsbDeviceWidget.other" href="spice-gtk/SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget.other"> +<ANCHOR id="SpiceUsbDeviceWidget.object-hierarchy" href="spice-gtk/SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget.object-hierarchy"> +<ANCHOR id="SpiceUsbDeviceWidget.implemented-interfaces" href="spice-gtk/SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget.implemented-interfaces"> +<ANCHOR id="SpiceUsbDeviceWidget.includes" href="spice-gtk/SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget.includes"> +<ANCHOR id="SpiceUsbDeviceWidget.description" href="spice-gtk/SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget.description"> +<ANCHOR id="SpiceUsbDeviceWidget.functions_details" href="spice-gtk/SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget.functions_details"> +<ANCHOR id="spice-usb-device-widget-new" href="spice-gtk/SpiceUsbDeviceWidget.html#spice-usb-device-widget-new"> +<ANCHOR id="SpiceUsbDeviceWidget.other_details" href="spice-gtk/SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget.other_details"> +<ANCHOR id="SpiceUsbDeviceWidget-struct" href="spice-gtk/SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget-struct"> +<ANCHOR id="SpiceUsbDeviceWidgetClass" href="spice-gtk/SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidgetClass"> +<ANCHOR id="SpiceUsbDeviceWidget.property-details" href="spice-gtk/SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget.property-details"> +<ANCHOR id="SpiceUsbDeviceWidget--device-format-string" href="spice-gtk/SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget--device-format-string"> +<ANCHOR id="SpiceUsbDeviceWidget--session" href="spice-gtk/SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget--session"> +<ANCHOR id="SpiceUsbDeviceWidget.signal-details" href="spice-gtk/SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget.signal-details"> +<ANCHOR id="SpiceUsbDeviceWidget-connect-failed" href="spice-gtk/SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget-connect-failed"> +<ANCHOR id="SpiceAudio" href="spice-gtk/SpiceAudio.html"> +<ANCHOR id="SpiceAudio.stability-level" href="spice-gtk/SpiceAudio.html#SpiceAudio.stability-level"> +<ANCHOR id="SpiceAudio.functions" href="spice-gtk/SpiceAudio.html#SpiceAudio.functions"> +<ANCHOR id="SpiceAudio.properties" href="spice-gtk/SpiceAudio.html#SpiceAudio.properties"> +<ANCHOR id="SpiceAudio.other" href="spice-gtk/SpiceAudio.html#SpiceAudio.other"> +<ANCHOR id="SpiceAudio.object-hierarchy" href="spice-gtk/SpiceAudio.html#SpiceAudio.object-hierarchy"> +<ANCHOR id="SpiceAudio.includes" href="spice-gtk/SpiceAudio.html#SpiceAudio.includes"> +<ANCHOR id="SpiceAudio.description" href="spice-gtk/SpiceAudio.html#SpiceAudio.description"> +<ANCHOR id="SpiceAudio.functions_details" href="spice-gtk/SpiceAudio.html#SpiceAudio.functions_details"> +<ANCHOR id="spice-audio-get" href="spice-gtk/SpiceAudio.html#spice-audio-get"> +<ANCHOR id="spice-audio-new" href="spice-gtk/SpiceAudio.html#spice-audio-new"> +<ANCHOR id="SpiceAudio.other_details" href="spice-gtk/SpiceAudio.html#SpiceAudio.other_details"> +<ANCHOR id="SpiceAudio-struct" href="spice-gtk/SpiceAudio.html#SpiceAudio-struct"> +<ANCHOR id="SpiceAudioClass" href="spice-gtk/SpiceAudio.html#SpiceAudioClass"> +<ANCHOR id="SpiceAudio.property-details" href="spice-gtk/SpiceAudio.html#SpiceAudio.property-details"> +<ANCHOR id="SpiceAudio--main-context" href="spice-gtk/SpiceAudio.html#SpiceAudio--main-context"> +<ANCHOR id="SpiceAudio--session" href="spice-gtk/SpiceAudio.html#SpiceAudio--session"> +<ANCHOR id="SpiceAudio.see-also" href="spice-gtk/SpiceAudio.html#SpiceAudio.see-also"> +<ANCHOR id="SpiceSmartcardManager" href="spice-gtk/SpiceSmartcardManager.html"> +<ANCHOR id="SpiceSmartcardManager.stability-level" href="spice-gtk/SpiceSmartcardManager.html#SpiceSmartcardManager.stability-level"> +<ANCHOR id="SpiceSmartcardManager.functions" href="spice-gtk/SpiceSmartcardManager.html#SpiceSmartcardManager.functions"> +<ANCHOR id="SpiceSmartcardManager.signals" href="spice-gtk/SpiceSmartcardManager.html#SpiceSmartcardManager.signals"> +<ANCHOR id="SpiceSmartcardManager.other" href="spice-gtk/SpiceSmartcardManager.html#SpiceSmartcardManager.other"> +<ANCHOR id="SpiceSmartcardManager.object-hierarchy" href="spice-gtk/SpiceSmartcardManager.html#SpiceSmartcardManager.object-hierarchy"> +<ANCHOR id="SpiceSmartcardManager.includes" href="spice-gtk/SpiceSmartcardManager.html#SpiceSmartcardManager.includes"> +<ANCHOR id="SpiceSmartcardManager.description" href="spice-gtk/SpiceSmartcardManager.html#SpiceSmartcardManager.description"> +<ANCHOR id="SpiceSmartcardManager.functions_details" href="spice-gtk/SpiceSmartcardManager.html#SpiceSmartcardManager.functions_details"> +<ANCHOR id="spice-smartcard-manager-get" href="spice-gtk/SpiceSmartcardManager.html#spice-smartcard-manager-get"> +<ANCHOR id="spice-smartcard-manager-get-readers" href="spice-gtk/SpiceSmartcardManager.html#spice-smartcard-manager-get-readers"> +<ANCHOR id="spice-smartcard-manager-insert-card" href="spice-gtk/SpiceSmartcardManager.html#spice-smartcard-manager-insert-card"> +<ANCHOR id="spice-smartcard-manager-remove-card" href="spice-gtk/SpiceSmartcardManager.html#spice-smartcard-manager-remove-card"> +<ANCHOR id="spice-smartcard-reader-is-software" href="spice-gtk/SpiceSmartcardManager.html#spice-smartcard-reader-is-software"> +<ANCHOR id="spice-smartcard-reader-insert-card" href="spice-gtk/SpiceSmartcardManager.html#spice-smartcard-reader-insert-card"> +<ANCHOR id="spice-smartcard-reader-remove-card" href="spice-gtk/SpiceSmartcardManager.html#spice-smartcard-reader-remove-card"> +<ANCHOR id="SpiceSmartcardManager.other_details" href="spice-gtk/SpiceSmartcardManager.html#SpiceSmartcardManager.other_details"> +<ANCHOR id="SpiceSmartcardManager-struct" href="spice-gtk/SpiceSmartcardManager.html#SpiceSmartcardManager-struct"> +<ANCHOR id="SpiceSmartcardManagerClass" href="spice-gtk/SpiceSmartcardManager.html#SpiceSmartcardManagerClass"> +<ANCHOR id="SpiceSmartcardReader" href="spice-gtk/SpiceSmartcardManager.html#SpiceSmartcardReader"> +<ANCHOR id="SpiceSmartcardManager.signal-details" href="spice-gtk/SpiceSmartcardManager.html#SpiceSmartcardManager.signal-details"> +<ANCHOR id="SpiceSmartcardManager-card-inserted" href="spice-gtk/SpiceSmartcardManager.html#SpiceSmartcardManager-card-inserted"> +<ANCHOR id="SpiceSmartcardManager-card-removed" href="spice-gtk/SpiceSmartcardManager.html#SpiceSmartcardManager-card-removed"> +<ANCHOR id="SpiceSmartcardManager-reader-added" href="spice-gtk/SpiceSmartcardManager.html#SpiceSmartcardManager-reader-added"> +<ANCHOR id="SpiceSmartcardManager-reader-removed" href="spice-gtk/SpiceSmartcardManager.html#SpiceSmartcardManager-reader-removed"> +<ANCHOR id="SpiceUsbDeviceManager" href="spice-gtk/SpiceUsbDeviceManager.html"> +<ANCHOR id="SpiceUsbDeviceManager.stability-level" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDeviceManager.stability-level"> +<ANCHOR id="SpiceUsbDeviceManager.functions" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDeviceManager.functions"> +<ANCHOR id="SpiceUsbDeviceManager.properties" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDeviceManager.properties"> +<ANCHOR id="SpiceUsbDeviceManager.signals" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDeviceManager.signals"> +<ANCHOR id="SpiceUsbDevice" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDevice"> +<ANCHOR id="SpiceUsbDeviceManager.other" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDeviceManager.other"> +<ANCHOR id="SpiceUsbDeviceManager.object-hierarchy" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDeviceManager.object-hierarchy"> +<ANCHOR id="SpiceUsbDeviceManager.implemented-interfaces" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDeviceManager.implemented-interfaces"> +<ANCHOR id="SpiceUsbDeviceManager.includes" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDeviceManager.includes"> +<ANCHOR id="SpiceUsbDeviceManager.description" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDeviceManager.description"> +<ANCHOR id="SpiceUsbDeviceManager.functions_details" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDeviceManager.functions_details"> +<ANCHOR id="spice-usb-device-manager-get" href="spice-gtk/SpiceUsbDeviceManager.html#spice-usb-device-manager-get"> +<ANCHOR id="spice-usb-device-manager-get-devices" href="spice-gtk/SpiceUsbDeviceManager.html#spice-usb-device-manager-get-devices"> +<ANCHOR id="spice-usb-device-manager-get-devices-with-filter" href="spice-gtk/SpiceUsbDeviceManager.html#spice-usb-device-manager-get-devices-with-filter"> +<ANCHOR id="spice-usb-device-manager-is-device-connected" href="spice-gtk/SpiceUsbDeviceManager.html#spice-usb-device-manager-is-device-connected"> +<ANCHOR id="spice-usb-device-manager-disconnect-device" href="spice-gtk/SpiceUsbDeviceManager.html#spice-usb-device-manager-disconnect-device"> +<ANCHOR id="spice-usb-device-manager-can-redirect-device" href="spice-gtk/SpiceUsbDeviceManager.html#spice-usb-device-manager-can-redirect-device"> +<ANCHOR id="spice-usb-device-manager-connect-device-async" href="spice-gtk/SpiceUsbDeviceManager.html#spice-usb-device-manager-connect-device-async"> +<ANCHOR id="spice-usb-device-manager-connect-device-finish" href="spice-gtk/SpiceUsbDeviceManager.html#spice-usb-device-manager-connect-device-finish"> +<ANCHOR id="spice-usb-device-get-description" href="spice-gtk/SpiceUsbDeviceManager.html#spice-usb-device-get-description"> +<ANCHOR id="spice-usb-device-get-libusb-device" href="spice-gtk/SpiceUsbDeviceManager.html#spice-usb-device-get-libusb-device"> +<ANCHOR id="SpiceUsbDeviceManager.other_details" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDeviceManager.other_details"> +<ANCHOR id="SpiceUsbDeviceManager-struct" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-struct"> +<ANCHOR id="SpiceUsbDeviceManagerClass" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDeviceManagerClass"> +<ANCHOR id="SpiceUsbDevice-struct" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDevice-struct"> +<ANCHOR id="SpiceUsbDeviceManager.property-details" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDeviceManager.property-details"> +<ANCHOR id="SpiceUsbDeviceManager--auto-connect" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDeviceManager--auto-connect"> +<ANCHOR id="SpiceUsbDeviceManager--auto-connect-filter" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDeviceManager--auto-connect-filter"> +<ANCHOR id="SpiceUsbDeviceManager--redirect-on-connect" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDeviceManager--redirect-on-connect"> +<ANCHOR id="SpiceUsbDeviceManager--session" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDeviceManager--session"> +<ANCHOR id="SpiceUsbDeviceManager.signal-details" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDeviceManager.signal-details"> +<ANCHOR id="SpiceUsbDeviceManager-auto-connect-failed" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-auto-connect-failed"> +<ANCHOR id="SpiceUsbDeviceManager-device-added" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-device-added"> +<ANCHOR id="SpiceUsbDeviceManager-device-error" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-device-error"> +<ANCHOR id="SpiceUsbDeviceManager-device-removed" href="spice-gtk/SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-device-removed"> +<ANCHOR id="spice-gtk-Utilities" href="spice-gtk/spice-gtk-Utilities.html"> +<ANCHOR id="spice-gtk-Utilities.stability-level" href="spice-gtk/spice-gtk-Utilities.html#spice-gtk-Utilities.stability-level"> +<ANCHOR id="spice-gtk-Utilities.functions" href="spice-gtk/spice-gtk-Utilities.html#spice-gtk-Utilities.functions"> +<ANCHOR id="spice-gtk-Utilities.includes" href="spice-gtk/spice-gtk-Utilities.html#spice-gtk-Utilities.includes"> +<ANCHOR id="spice-gtk-Utilities.description" href="spice-gtk/spice-gtk-Utilities.html#spice-gtk-Utilities.description"> +<ANCHOR id="spice-gtk-Utilities.functions_details" href="spice-gtk/spice-gtk-Utilities.html#spice-gtk-Utilities.functions_details"> +<ANCHOR id="spice-util-set-debug" href="spice-gtk/spice-gtk-Utilities.html#spice-util-set-debug"> +<ANCHOR id="spice-util-get-version-string" href="spice-gtk/spice-gtk-Utilities.html#spice-util-get-version-string"> +<ANCHOR id="spice-uuid-to-string" href="spice-gtk/spice-gtk-Utilities.html#spice-uuid-to-string"> +<ANCHOR id="spice-gtk-Utilities.other_details" href="spice-gtk/spice-gtk-Utilities.html#spice-gtk-Utilities.other_details"> +<ANCHOR id="spice-gtk-Version-Information" href="spice-gtk/spice-gtk-Version-Information.html"> +<ANCHOR id="spice-gtk-Version-Information.functions" href="spice-gtk/spice-gtk-Version-Information.html#spice-gtk-Version-Information.functions"> +<ANCHOR id="spice-gtk-Version-Information.includes" href="spice-gtk/spice-gtk-Version-Information.html#spice-gtk-Version-Information.includes"> +<ANCHOR id="spice-gtk-Version-Information.description" href="spice-gtk/spice-gtk-Version-Information.html#spice-gtk-Version-Information.description"> +<ANCHOR id="spice-gtk-Version-Information.functions_details" href="spice-gtk/spice-gtk-Version-Information.html#spice-gtk-Version-Information.functions_details"> +<ANCHOR id="SPICE-GTK-CHECK-VERSION:CAPS" href="spice-gtk/spice-gtk-Version-Information.html#SPICE-GTK-CHECK-VERSION:CAPS"> +<ANCHOR id="SPICE-GTK-MAJOR-VERSION:CAPS" href="spice-gtk/spice-gtk-Version-Information.html#SPICE-GTK-MAJOR-VERSION:CAPS"> +<ANCHOR id="SPICE-GTK-MICRO-VERSION:CAPS" href="spice-gtk/spice-gtk-Version-Information.html#SPICE-GTK-MICRO-VERSION:CAPS"> +<ANCHOR id="SPICE-GTK-MINOR-VERSION:CAPS" href="spice-gtk/spice-gtk-Version-Information.html#SPICE-GTK-MINOR-VERSION:CAPS"> +<ANCHOR id="spice-gtk-Version-Information.other_details" href="spice-gtk/spice-gtk-Version-Information.html#spice-gtk-Version-Information.other_details"> +<ANCHOR id="spice-gtk-SpiceURI" href="spice-gtk/spice-gtk-SpiceURI.html"> +<ANCHOR id="spice-gtk-SpiceURI.stability-level" href="spice-gtk/spice-gtk-SpiceURI.html#spice-gtk-SpiceURI.stability-level"> +<ANCHOR id="spice-gtk-SpiceURI.functions" href="spice-gtk/spice-gtk-SpiceURI.html#spice-gtk-SpiceURI.functions"> +<ANCHOR id="spice-gtk-SpiceURI.other" href="spice-gtk/spice-gtk-SpiceURI.html#spice-gtk-SpiceURI.other"> +<ANCHOR id="spice-gtk-SpiceURI.includes" href="spice-gtk/spice-gtk-SpiceURI.html#spice-gtk-SpiceURI.includes"> +<ANCHOR id="spice-gtk-SpiceURI.description" href="spice-gtk/spice-gtk-SpiceURI.html#spice-gtk-SpiceURI.description"> +<ANCHOR id="spice-gtk-SpiceURI.functions_details" href="spice-gtk/spice-gtk-SpiceURI.html#spice-gtk-SpiceURI.functions_details"> +<ANCHOR id="spice-uri-get-scheme" href="spice-gtk/spice-gtk-SpiceURI.html#spice-uri-get-scheme"> +<ANCHOR id="spice-uri-set-scheme" href="spice-gtk/spice-gtk-SpiceURI.html#spice-uri-set-scheme"> +<ANCHOR id="spice-uri-get-hostname" href="spice-gtk/spice-gtk-SpiceURI.html#spice-uri-get-hostname"> +<ANCHOR id="spice-uri-set-hostname" href="spice-gtk/spice-gtk-SpiceURI.html#spice-uri-set-hostname"> +<ANCHOR id="spice-uri-get-port" href="spice-gtk/spice-gtk-SpiceURI.html#spice-uri-get-port"> +<ANCHOR id="spice-uri-set-port" href="spice-gtk/spice-gtk-SpiceURI.html#spice-uri-set-port"> +<ANCHOR id="spice-uri-get-user" href="spice-gtk/spice-gtk-SpiceURI.html#spice-uri-get-user"> +<ANCHOR id="spice-uri-set-user" href="spice-gtk/spice-gtk-SpiceURI.html#spice-uri-set-user"> +<ANCHOR id="spice-uri-get-password" href="spice-gtk/spice-gtk-SpiceURI.html#spice-uri-get-password"> +<ANCHOR id="spice-uri-set-password" href="spice-gtk/spice-gtk-SpiceURI.html#spice-uri-set-password"> +<ANCHOR id="spice-uri-to-string" href="spice-gtk/spice-gtk-SpiceURI.html#spice-uri-to-string"> +<ANCHOR id="spice-gtk-SpiceURI.other_details" href="spice-gtk/spice-gtk-SpiceURI.html#spice-gtk-SpiceURI.other_details"> +<ANCHOR id="SpiceURIClass" href="spice-gtk/spice-gtk-SpiceURI.html#SpiceURIClass"> +<ANCHOR id="SpiceURI" href="spice-gtk/spice-gtk-SpiceURI.html#SpiceURI"> +<ANCHOR id="SpiceFileTransferTask" href="spice-gtk/SpiceFileTransferTask.html"> +<ANCHOR id="SpiceFileTransferTask.stability-level" href="spice-gtk/SpiceFileTransferTask.html#SpiceFileTransferTask.stability-level"> +<ANCHOR id="SpiceFileTransferTask.functions" href="spice-gtk/SpiceFileTransferTask.html#SpiceFileTransferTask.functions"> +<ANCHOR id="SpiceFileTransferTask.properties" href="spice-gtk/SpiceFileTransferTask.html#SpiceFileTransferTask.properties"> +<ANCHOR id="SpiceFileTransferTask.signals" href="spice-gtk/SpiceFileTransferTask.html#SpiceFileTransferTask.signals"> +<ANCHOR id="SpiceFileTransferTask.other" href="spice-gtk/SpiceFileTransferTask.html#SpiceFileTransferTask.other"> +<ANCHOR id="SpiceFileTransferTask.object-hierarchy" href="spice-gtk/SpiceFileTransferTask.html#SpiceFileTransferTask.object-hierarchy"> +<ANCHOR id="SpiceFileTransferTask.includes" href="spice-gtk/SpiceFileTransferTask.html#SpiceFileTransferTask.includes"> +<ANCHOR id="SpiceFileTransferTask.description" href="spice-gtk/SpiceFileTransferTask.html#SpiceFileTransferTask.description"> +<ANCHOR id="SpiceFileTransferTask.functions_details" href="spice-gtk/SpiceFileTransferTask.html#SpiceFileTransferTask.functions_details"> +<ANCHOR id="spice-file-transfer-task-get-progress" href="spice-gtk/SpiceFileTransferTask.html#spice-file-transfer-task-get-progress"> +<ANCHOR id="spice-file-transfer-task-get-filename" href="spice-gtk/SpiceFileTransferTask.html#spice-file-transfer-task-get-filename"> +<ANCHOR id="spice-file-transfer-task-cancel" href="spice-gtk/SpiceFileTransferTask.html#spice-file-transfer-task-cancel"> +<ANCHOR id="SpiceFileTransferTask.other_details" href="spice-gtk/SpiceFileTransferTask.html#SpiceFileTransferTask.other_details"> +<ANCHOR id="SpiceFileTransferTask-struct" href="spice-gtk/SpiceFileTransferTask.html#SpiceFileTransferTask-struct"> +<ANCHOR id="SpiceFileTransferTaskClass" href="spice-gtk/SpiceFileTransferTask.html#SpiceFileTransferTaskClass"> +<ANCHOR id="SpiceFileTransferTask.property-details" href="spice-gtk/SpiceFileTransferTask.html#SpiceFileTransferTask.property-details"> +<ANCHOR id="SpiceFileTransferTask--cancellable" href="spice-gtk/SpiceFileTransferTask.html#SpiceFileTransferTask--cancellable"> +<ANCHOR id="SpiceFileTransferTask--channel" href="spice-gtk/SpiceFileTransferTask.html#SpiceFileTransferTask--channel"> +<ANCHOR id="SpiceFileTransferTask--file" href="spice-gtk/SpiceFileTransferTask.html#SpiceFileTransferTask--file"> +<ANCHOR id="SpiceFileTransferTask--id" href="spice-gtk/SpiceFileTransferTask.html#SpiceFileTransferTask--id"> +<ANCHOR id="SpiceFileTransferTask--progress" href="spice-gtk/SpiceFileTransferTask.html#SpiceFileTransferTask--progress"> +<ANCHOR id="SpiceFileTransferTask.signal-details" href="spice-gtk/SpiceFileTransferTask.html#SpiceFileTransferTask.signal-details"> +<ANCHOR id="SpiceFileTransferTask-finished" href="spice-gtk/SpiceFileTransferTask.html#SpiceFileTransferTask-finished"> +<ANCHOR id="SpiceFileTransferTask.see-also" href="spice-gtk/SpiceFileTransferTask.html#SpiceFileTransferTask.see-also"> +<ANCHOR id="annotation-glossterm-allow-none" href="spice-gtk/annotation-glossary.html#annotation-glossterm-allow-none"> +<ANCHOR id="annotation-glossterm-array" href="spice-gtk/annotation-glossary.html#annotation-glossterm-array"> +<ANCHOR id="annotation-glossterm-closure" href="spice-gtk/annotation-glossary.html#annotation-glossterm-closure"> +<ANCHOR id="annotation-glossterm-element-type" href="spice-gtk/annotation-glossary.html#annotation-glossterm-element-type"> +<ANCHOR id="annotation-glossterm-scope async" href="spice-gtk/annotation-glossary.html#annotation-glossterm-scope async"> +<ANCHOR id="annotation-glossterm-scope call" href="spice-gtk/annotation-glossary.html#annotation-glossterm-scope call"> +<ANCHOR id="annotation-glossterm-skip" href="spice-gtk/annotation-glossary.html#annotation-glossterm-skip"> +<ANCHOR id="annotation-glossterm-Stable" href="spice-gtk/annotation-glossary.html#annotation-glossterm-Stable"> +<ANCHOR id="annotation-glossterm-transfer container" href="spice-gtk/annotation-glossary.html#annotation-glossterm-transfer container"> +<ANCHOR id="annotation-glossterm-transfer full" href="spice-gtk/annotation-glossary.html#annotation-glossterm-transfer full"> +<ANCHOR id="annotation-glossterm-transfer none" href="spice-gtk/annotation-glossary.html#annotation-glossterm-transfer none"> diff --git a/content-extra/api/spice-gtk/left-insensitive.png b/content-extra/api/spice-gtk/left-insensitive.png Binary files differnew file mode 100644 index 0000000..3269393 --- /dev/null +++ b/content-extra/api/spice-gtk/left-insensitive.png diff --git a/content-extra/api/spice-gtk/left.png b/content-extra/api/spice-gtk/left.png Binary files differnew file mode 100644 index 0000000..2abde03 --- /dev/null +++ b/content-extra/api/spice-gtk/left.png diff --git a/content-extra/api/spice-gtk/object-tree.html b/content-extra/api/spice-gtk/object-tree.html new file mode 100644 index 0000000..81bf8fb --- /dev/null +++ b/content-extra/api/spice-gtk/object-tree.html @@ -0,0 +1,65 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Object Hierarchy: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="prev" href="SpiceFileTransferTask.html" title="File Transfer Task"> +<link rel="next" href="api-index-full.html" title="API Index"> +<meta name="generator" content="GTK-Doc V1.24 (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"></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="SpiceFileTransferTask.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="api-index-full.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h1 class="title"> +<a name="object-tree"></a>Object Hierarchy</h1></div></div></div> +<pre class="screen"> + <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">├──</span> <a class="link" href="SpiceAudio.html" title="Spice Audio">SpiceAudio</a> + <span class="lineart">├──</span> <a class="link" href="SpiceChannel.html" title="Spice Channel">SpiceChannel</a> + <span class="lineart">│</span> <span class="lineart">├──</span> <a class="link" href="SpiceCursorChannel.html" title="Cursor Channel">SpiceCursorChannel</a> + <span class="lineart">│</span> <span class="lineart">├──</span> <a class="link" href="SpiceDisplayChannel.html" title="Display Channel">SpiceDisplayChannel</a> + <span class="lineart">│</span> <span class="lineart">├──</span> <a class="link" href="SpiceInputsChannel.html" title="Inputs Channel">SpiceInputsChannel</a> + <span class="lineart">│</span> <span class="lineart">├──</span> <a class="link" href="SpiceMainChannel.html" title="Main Channel">SpiceMainChannel</a> + <span class="lineart">│</span> <span class="lineart">├──</span> <a class="link" href="SpicePlaybackChannel.html" title="Playback Channel">SpicePlaybackChannel</a> + <span class="lineart">│</span> <span class="lineart">├──</span> <a class="link" href="SpiceRecordChannel.html" title="Record Channel">SpiceRecordChannel</a> + <span class="lineart">│</span> <span class="lineart">├──</span> <a class="link" href="SpiceSmartcardChannel.html" title="Smartcard Channel">SpiceSmartcardChannel</a> + <span class="lineart">│</span> <span class="lineart">├──</span> <a class="link" href="SpiceUsbredirChannel.html" title="USB Redirection Channel">SpiceUsbredirChannel</a> + <span class="lineart">│</span> <span class="lineart">╰──</span> <a class="link" href="SpicePortChannel.html" title="Port Channel">SpicePortChannel</a> + <span class="lineart">│</span> <span class="lineart">╰──</span> <a class="link" href="SpiceWebdavChannel.html" title="WebDAV Channel">SpiceWebdavChannel</a> + <span class="lineart">├──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> + <span class="lineart">│</span> <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk2/GtkWidget.html">GtkWidget</a> + <span class="lineart">│</span> <span class="lineart">├──</span> <a href="/usr/share/gtk-doc/html/gtk2/GtkDrawingArea.html">GtkDrawingArea</a> + <span class="lineart">│</span> <span class="lineart">│</span> <span class="lineart">╰──</span> <a class="link" href="SpiceDisplay.html" title="Spice Display">SpiceDisplay</a> + <span class="lineart">│</span> <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk2/GtkContainer.html">GtkContainer</a> + <span class="lineart">│</span> <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk2/GtkBox.html">GtkBox</a> + <span class="lineart">│</span> <span class="lineart">╰──</span> <a class="link" href="SpiceUsbDeviceWidget.html" title="Spice USB device selection widget">SpiceUsbDeviceWidget</a> + <span class="lineart">├──</span> <a class="link" href="SpiceGtkSession.html" title="Spice GTK Session">SpiceGtkSession</a> + <span class="lineart">├──</span> <a class="link" href="SpiceSession.html" title="Spice Session">SpiceSession</a> + <span class="lineart">├──</span> <a class="link" href="SpiceSmartcardManager.html" title="Spice Smartcard Manager">SpiceSmartcardManager</a> + <span class="lineart">├──</span> <a class="link" href="SpiceUsbDeviceManager.html" title="Spice USB Manager">SpiceUsbDeviceManager</a> + <span class="lineart">╰──</span> <a class="link" href="SpiceFileTransferTask.html" title="File Transfer Task">SpiceFileTransferTask</a> + <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a> + <span class="lineart">├──</span> <a class="link" href="SpiceChannel.html#SpiceChannelEvent" title="enum SpiceChannelEvent">SpiceChannelEvent</a> + <span class="lineart">╰──</span> <a class="link" href="SpiceSession.html#SpiceSessionMigration" title="enum SpiceSessionMigration">SpiceSessionMigration</a> + <a href="/usr/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a> + <span class="lineart">├──</span> <a class="link" href="SpiceDisplay.html#SpiceGrabSequence">SpiceGrabSequence</a> + <span class="lineart">╰──</span> <a class="link" href="SpiceUsbDeviceManager.html#SpiceUsbDevice">SpiceUsbDevice</a> + <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GFlags</a> + <span class="lineart">├──</span> <a class="link" href="SpiceInputsChannel.html#SpiceInputsLock" title="enum SpiceInputsLock">SpiceInputsLock</a> + <span class="lineart">╰──</span> <a class="link" href="SpiceSession.html#SpiceSessionVerify" title="enum SpiceSessionVerify">SpiceSessionVerify</a> +</pre> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/right-insensitive.png b/content-extra/api/spice-gtk/right-insensitive.png Binary files differnew file mode 100644 index 0000000..4c95785 --- /dev/null +++ b/content-extra/api/spice-gtk/right-insensitive.png diff --git a/content-extra/api/spice-gtk/right.png b/content-extra/api/spice-gtk/right.png Binary files differnew file mode 100644 index 0000000..76260ec --- /dev/null +++ b/content-extra/api/spice-gtk/right.png diff --git a/content-extra/api/spice-gtk/spice-gtk-SpiceURI.html b/content-extra/api/spice-gtk/spice-gtk-SpiceURI.html new file mode 100644 index 0000000..414dfd3 --- /dev/null +++ b/content-extra/api/spice-gtk/spice-gtk-SpiceURI.html @@ -0,0 +1,527 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>SpiceURI: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="application-support.html" title="Application Support, from spice-client-glib"> +<link rel="prev" href="spice-gtk-Version-Information.html" title="Version Information"> +<link rel="next" href="SpiceFileTransferTask.html" title="File Transfer Task"> +<meta name="generator" content="GTK-Doc V1.24 (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-SpiceURI.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="application-support.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="spice-gtk-Version-Information.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="SpiceFileTransferTask.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="spice-gtk-SpiceURI"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="spice-gtk-SpiceURI.top_of_page"></a>SpiceURI</span></h2> +<p>SpiceURI — URIs handling</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="spice-gtk-SpiceURI.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-SpiceURI.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-SpiceURI.html#spice-uri-get-scheme" title="spice_uri_get_scheme ()">spice_uri_get_scheme</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-SpiceURI.html#spice-uri-set-scheme" title="spice_uri_set_scheme ()">spice_uri_set_scheme</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-SpiceURI.html#spice-uri-get-hostname" title="spice_uri_get_hostname ()">spice_uri_get_hostname</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-SpiceURI.html#spice-uri-set-hostname" title="spice_uri_set_hostname ()">spice_uri_set_hostname</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-SpiceURI.html#spice-uri-get-port" title="spice_uri_get_port ()">spice_uri_get_port</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-SpiceURI.html#spice-uri-set-port" title="spice_uri_set_port ()">spice_uri_set_port</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-SpiceURI.html#spice-uri-get-user" title="spice_uri_get_user ()">spice_uri_get_user</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-SpiceURI.html#spice-uri-set-user" title="spice_uri_set_user ()">spice_uri_set_user</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-SpiceURI.html#spice-uri-get-password" title="spice_uri_get_password ()">spice_uri_get_password</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-SpiceURI.html#spice-uri-set-password" title="spice_uri_set_password ()">spice_uri_set_password</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-SpiceURI.html#spice-uri-to-string" title="spice_uri_to_string ()">spice_uri_to_string</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="spice-gtk-SpiceURI.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="spice-gtk-SpiceURI.html#SpiceURIClass" title="SpiceURIClass">SpiceURIClass</a></td> +</tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI">SpiceURI</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="spice-gtk-SpiceURI.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-client.h> +</pre> +</div> +<div class="refsect1"> +<a name="spice-gtk-SpiceURI.description"></a><h2>Description</h2> +<p>A SpiceURI represents a (parsed) URI.</p> +</div> +<div class="refsect1"> +<a name="spice-gtk-SpiceURI.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="spice-uri-get-scheme"></a><h3>spice_uri_get_scheme ()</h3> +<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +spice_uri_get_scheme (<em class="parameter"><code><a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a> *uri</code></em>);</pre> +<p>Gets <em class="parameter"><code>uri</code></em> +'s scheme.</p> +<div class="refsect3"> +<a name="id-1.2.5.7.8.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>uri</p></td> +<td class="parameter_description"><p>a <a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.5.7.8.2.6"></a><h4>Returns</h4> +<p> <em class="parameter"><code>uri</code></em> +'s scheme.</p> +</div> +<p class="since">Since: 0.24</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-uri-set-scheme"></a><h3>spice_uri_set_scheme ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_uri_set_scheme (<em class="parameter"><code><a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a> *uri</code></em>, + <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *scheme</code></em>);</pre> +<p>Sets <em class="parameter"><code>uri</code></em> +'s scheme to <em class="parameter"><code>scheme</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.2.5.7.8.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>uri</p></td> +<td class="parameter_description"><p>a <a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>scheme</p></td> +<td class="parameter_description"><p>the scheme</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: 0.24</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-uri-get-hostname"></a><h3>spice_uri_get_hostname ()</h3> +<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +spice_uri_get_hostname (<em class="parameter"><code><a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a> *uri</code></em>);</pre> +<p>Gets <em class="parameter"><code>uri</code></em> +'s hostname.</p> +<div class="refsect3"> +<a name="id-1.2.5.7.8.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>uri</p></td> +<td class="parameter_description"><p>a <a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.5.7.8.4.6"></a><h4>Returns</h4> +<p> <em class="parameter"><code>uri</code></em> +'s hostname.</p> +</div> +<p class="since">Since: 0.24</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-uri-set-hostname"></a><h3>spice_uri_set_hostname ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_uri_set_hostname (<em class="parameter"><code><a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a> *uri</code></em>, + <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *hostname</code></em>);</pre> +<p>Sets <em class="parameter"><code>uri</code></em> +'s hostname to <em class="parameter"><code>hostname</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.2.5.7.8.5.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>uri</p></td> +<td class="parameter_description"><p>a <a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>hostname</p></td> +<td class="parameter_description"><p>the hostname</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: 0.24</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-uri-get-port"></a><h3>spice_uri_get_port ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> +spice_uri_get_port (<em class="parameter"><code><a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a> *uri</code></em>);</pre> +<p>Gets <em class="parameter"><code>uri</code></em> +'s port.</p> +<div class="refsect3"> +<a name="id-1.2.5.7.8.6.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>uri</p></td> +<td class="parameter_description"><p>a <a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.5.7.8.6.6"></a><h4>Returns</h4> +<p> <em class="parameter"><code>uri</code></em> +'s port.</p> +</div> +<p class="since">Since: 0.24</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-uri-set-port"></a><h3>spice_uri_set_port ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_uri_set_port (<em class="parameter"><code><a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a> *uri</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> port</code></em>);</pre> +<p>Sets <em class="parameter"><code>uri</code></em> +'s port to <em class="parameter"><code>port</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.2.5.7.8.7.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>uri</p></td> +<td class="parameter_description"><p>a <a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>port</p></td> +<td class="parameter_description"><p>the port</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: 0.24</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-uri-get-user"></a><h3>spice_uri_get_user ()</h3> +<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +spice_uri_get_user (<em class="parameter"><code><a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a> *uri</code></em>);</pre> +<p>Gets <em class="parameter"><code>uri</code></em> +'s user.</p> +<div class="refsect3"> +<a name="id-1.2.5.7.8.8.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>uri</p></td> +<td class="parameter_description"><p>a <a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.5.7.8.8.6"></a><h4>Returns</h4> +<p> <em class="parameter"><code>uri</code></em> +'s user.</p> +</div> +<p class="since">Since: 0.24</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-uri-set-user"></a><h3>spice_uri_set_user ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_uri_set_user (<em class="parameter"><code><a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a> *uri</code></em>, + <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *user</code></em>);</pre> +<p>Sets <em class="parameter"><code>uri</code></em> +'s user to <em class="parameter"><code>user</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.2.5.7.8.9.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>uri</p></td> +<td class="parameter_description"><p>a <a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user</p></td> +<td class="parameter_description"><p>the user, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: 0.24</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-uri-get-password"></a><h3>spice_uri_get_password ()</h3> +<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +spice_uri_get_password (<em class="parameter"><code><a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a> *uri</code></em>);</pre> +<p>Gets <em class="parameter"><code>uri</code></em> +'s password.</p> +<div class="refsect3"> +<a name="id-1.2.5.7.8.10.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>uri</p></td> +<td class="parameter_description"><p>a <a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.5.7.8.10.6"></a><h4>Returns</h4> +<p> <em class="parameter"><code>uri</code></em> +'s password.</p> +</div> +<p class="since">Since: 0.24</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-uri-set-password"></a><h3>spice_uri_set_password ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_uri_set_password (<em class="parameter"><code><a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a> *uri</code></em>, + <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *password</code></em>);</pre> +<p>Sets <em class="parameter"><code>uri</code></em> +'s password to <em class="parameter"><code>password</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.2.5.7.8.11.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>uri</p></td> +<td class="parameter_description"><p>a <a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>password</p></td> +<td class="parameter_description"><p>the password, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: 0.24</p> +</div> +<hr> +<div class="refsect2"> +<a name="spice-uri-to-string"></a><h3>spice_uri_to_string ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +spice_uri_to_string (<em class="parameter"><code><a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a> *uri</code></em>);</pre> +<p>Returns a string representing <em class="parameter"><code>uri</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.2.5.7.8.12.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>uri</p></td> +<td class="parameter_description"><p>a <a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.5.7.8.12.6"></a><h4>Returns</h4> +<p> a string representing <em class="parameter"><code>uri</code></em> +, which the caller must free.</p> +</div> +<p class="since">Since: 0.24</p> +</div> +</div> +<div class="refsect1"> +<a name="spice-gtk-SpiceURI.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SpiceURIClass"></a><h3>SpiceURIClass</h3> +<pre class="programlisting">typedef struct _SpiceURIClass SpiceURIClass;</pre> +<p>The <a class="link" href="spice-gtk-SpiceURI.html#SpiceURIClass" title="SpiceURIClass"><span class="type">SpiceURIClass</span></a> struct is opaque and cannot be accessed directly. +It is class structure for <a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a>.</p> +</div> +<hr> +<div class="refsect2"> +<a name="SpiceURI"></a><h3>SpiceURI</h3> +<pre class="programlisting">typedef struct _SpiceURI SpiceURI;</pre> +<p>The <a class="link" href="spice-gtk-SpiceURI.html#SpiceURI" title="SpiceURI"><span class="type">SpiceURI</span></a> struct is opaque and cannot be accessed directly.</p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/spice-gtk-Utilities.html b/content-extra/api/spice-gtk/spice-gtk-Utilities.html new file mode 100644 index 0000000..e015099 --- /dev/null +++ b/content-extra/api/spice-gtk/spice-gtk-Utilities.html @@ -0,0 +1,158 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Utilities: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="application-support.html" title="Application Support, from spice-client-glib"> +<link rel="prev" href="SpiceUsbDeviceManager.html" title="Spice USB Manager"> +<link rel="next" href="spice-gtk-Version-Information.html" title="Version Information"> +<meta name="generator" content="GTK-Doc V1.24 (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-Utilities.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="application-support.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="SpiceUsbDeviceManager.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="spice-gtk-Version-Information.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="spice-gtk-Utilities"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="spice-gtk-Utilities.top_of_page"></a>Utilities</span></h2> +<p>Utilities — version and debugging functions</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="spice-gtk-Utilities.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-Utilities.functions"></a><h2>Functions</h2> +<div class="informaltable"><table 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">void</span> +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-Utilities.html#spice-util-set-debug" title="spice_util_set_debug ()">spice_util_set_debug</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-Utilities.html#spice-util-get-version-string" title="spice_util_get_version_string ()">spice_util_get_version_string</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +</td> +<td class="function_name"> +<a class="link" href="spice-gtk-Utilities.html#spice-uuid-to-string" title="spice_uuid_to_string ()">spice_uuid_to_string</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="spice-gtk-Utilities.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-client.h> +</pre> +</div> +<div class="refsect1"> +<a name="spice-gtk-Utilities.description"></a><h2>Description</h2> +<p>Various functions for debugging and informational purposes.</p> +</div> +<div class="refsect1"> +<a name="spice-gtk-Utilities.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="spice-util-set-debug"></a><h3>spice_util_set_debug ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +spice_util_set_debug (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> enabled</code></em>);</pre> +<p>Enable or disable Spice-GTK debugging messages.</p> +<div class="refsect3"> +<a name="id-1.2.5.5.7.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>enabled</p></td> +<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-util-get-version-string"></a><h3>spice_util_get_version_string ()</h3> +<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +spice_util_get_version_string (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p>Gets the version string</p> +<div class="refsect3"> +<a name="id-1.2.5.5.7.3.5"></a><h4>Returns</h4> +<p> Spice-GTK version as a const string.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="spice-uuid-to-string"></a><h3>spice_uuid_to_string ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +spice_uuid_to_string (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> uuid[16]</code></em>);</pre> +<p>Creates a string representation of <em class="parameter"><code>uuid</code></em> +, of the form +"06e023d5-86d8-420e-8103-383e4566087a"</p> +<div class="refsect3"> +<a name="id-1.2.5.5.7.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>uuid</p></td> +<td class="parameter_description"><p>UUID byte array</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.5.5.7.4.6"></a><h4>Returns</h4> +<p> A string that should be freed with <a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>.</p> +</div> +<p class="since">Since: 0.22</p> +</div> +</div> +<div class="refsect1"> +<a name="spice-gtk-Utilities.other_details"></a><h2>Types and Values</h2> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</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 new file mode 100644 index 0000000..7e48c2f --- /dev/null +++ b/content-extra/api/spice-gtk/spice-gtk-Version-Information.html @@ -0,0 +1,141 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Version Information: Spice-GTK Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Spice-GTK Reference Manual"> +<link rel="up" href="application-support.html" title="Application Support, from spice-client-glib"> +<link rel="prev" href="spice-gtk-Utilities.html" title="Utilities"> +<link rel="next" href="spice-gtk-SpiceURI.html" title="SpiceURI"> +<meta name="generator" content="GTK-Doc V1.24 (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-Version-Information.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="application-support.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="spice-gtk-Utilities.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="spice-gtk-SpiceURI.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="spice-gtk-Version-Information"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="spice-gtk-Version-Information.top_of_page"></a>Version Information</span></h2> +<p>Version Information — Spice-Gtk version checking</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="spice-gtk-Version-Information.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"> +<a class="link" href="spice-gtk-Version-Information.html#SPICE-GTK-CHECK-VERSION:CAPS" title="SPICE_GTK_CHECK_VERSION()">SPICE_GTK_CHECK_VERSION</a><span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="spice-gtk-Version-Information.html#SPICE-GTK-MAJOR-VERSION:CAPS" title="SPICE_GTK_MAJOR_VERSION">SPICE_GTK_MAJOR_VERSION</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="spice-gtk-Version-Information.html#SPICE-GTK-MICRO-VERSION:CAPS" title="SPICE_GTK_MICRO_VERSION">SPICE_GTK_MICRO_VERSION</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="spice-gtk-Version-Information.html#SPICE-GTK-MINOR-VERSION:CAPS" title="SPICE_GTK_MINOR_VERSION">SPICE_GTK_MINOR_VERSION</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="spice-gtk-Version-Information.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <spice-version.h> +</pre> +</div> +<div class="refsect1"> +<a name="spice-gtk-Version-Information.description"></a><h2>Description</h2> +<p>Spice-Gtk provides macros to check the version of the library +at compile-time</p> +</div> +<div class="refsect1"> +<a name="spice-gtk-Version-Information.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="SPICE-GTK-CHECK-VERSION:CAPS"></a><h3>SPICE_GTK_CHECK_VERSION()</h3> +<pre class="programlisting">#define SPICE_GTK_CHECK_VERSION(major, minor, micro)</pre> +<p>Compile-time version checking. Evaluates to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the version +of Spice-Gtk is greater than the required one.</p> +<div class="refsect3"> +<a name="id-1.2.5.6.6.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>major</p></td> +<td class="parameter_description"><p>required major version</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>minor</p></td> +<td class="parameter_description"><p>required minor version</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>micro</p></td> +<td class="parameter_description"><p>required micro version</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: 0.24</p> +</div> +<hr> +<div class="refsect2"> +<a name="SPICE-GTK-MAJOR-VERSION:CAPS"></a><h3>SPICE_GTK_MAJOR_VERSION</h3> +<pre class="programlisting">#define SPICE_GTK_MAJOR_VERSION (0) +</pre> +<p>Spice-Gtk major version component (e.g. 1 if version is 1.2.3)</p> +<p class="since">Since: 0.24</p> +</div> +<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 (16) +</pre> +<p>Spice-Gtk micro version component (e.g. 3 if version is 1.2.3)</p> +<p class="since">Since: 0.24</p> +</div> +<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 (30) +</pre> +<p>Spice-Gtk minor version component (e.g. 2 if version is 1.2.3)</p> +<p class="since">Since: 0.24</p> +</div> +</div> +<div class="refsect1"> +<a name="spice-gtk-Version-Information.other_details"></a><h2>Types and Values</h2> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> +</body> +</html>
\ No newline at end of file diff --git a/content-extra/api/spice-gtk/spice-gtk.devhelp2 b/content-extra/api/spice-gtk/spice-gtk.devhelp2 new file mode 100644 index 0000000..4a3f444 --- /dev/null +++ b/content-extra/api/spice-gtk/spice-gtk.devhelp2 @@ -0,0 +1,372 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<book xmlns="http://www.devhelp.net/book" title="Spice-GTK Reference Manual" link="index.html" author="" name="spice-gtk" version="2" language="c"> + <chapters> + <sub name="API Reference" link="api-reference.html"> + <sub name="Object Hierarchy" link="ch01.html"/> + <sub name="Session and Channels Objects, from spice-client-glib" link="ch02.html"> + <sub name="Spice Session" link="SpiceSession.html"/> + <sub name="Spice Channel" link="SpiceChannel.html"/> + <sub name="Cursor Channel" link="SpiceCursorChannel.html"/> + <sub name="Display Channel" link="SpiceDisplayChannel.html"/> + <sub name="Inputs Channel" link="SpiceInputsChannel.html"/> + <sub name="Main Channel" link="SpiceMainChannel.html"/> + <sub name="Playback Channel" link="SpicePlaybackChannel.html"/> + <sub name="Record Channel" link="SpiceRecordChannel.html"/> + <sub name="Smartcard Channel" link="SpiceSmartcardChannel.html"/> + <sub name="USB Redirection Channel" link="SpiceUsbredirChannel.html"/> + <sub name="Port Channel" link="SpicePortChannel.html"/> + <sub name="WebDAV Channel" link="SpiceWebdavChannel.html"/> + </sub> + <sub name="GTK Widget, from spice-client-gtk" link="ch03.html"> + <sub name="Spice GTK Session" link="SpiceGtkSession.html"/> + <sub name="Spice Display" link="SpiceDisplay.html"/> + <sub name="Spice USB device selection widget" link="SpiceUsbDeviceWidget.html"/> + </sub> + <sub name="Application Support, from spice-client-glib" link="application-support.html"> + <sub name="Spice Audio" link="SpiceAudio.html"/> + <sub name="Spice Smartcard Manager" link="SpiceSmartcardManager.html"/> + <sub name="Spice USB Manager" link="SpiceUsbDeviceManager.html"/> + <sub name="Utilities" link="spice-gtk-Utilities.html"/> + <sub name="Version Information" link="spice-gtk-Version-Information.html"/> + <sub name="SpiceURI" link="spice-gtk-SpiceURI.html"/> + <sub name="File Transfer Task" link="SpiceFileTransferTask.html"/> + </sub> + </sub> + <sub name="Object Hierarchy" link="object-tree.html"/> + <sub name="API Index" link="api-index-full.html"/> + <sub name="Index of deprecated symbols" link="api-index-deprecated.html"/> + <sub name="Annotation Glossary" link="annotation-glossary.html"/> + </chapters> + <functions> + <keyword type="function" name="spice_session_new ()" link="SpiceSession.html#spice-session-new"/> + <keyword type="function" name="spice_session_connect ()" link="SpiceSession.html#spice-session-connect"/> + <keyword type="function" name="spice_session_open_fd ()" link="SpiceSession.html#spice-session-open-fd"/> + <keyword type="function" name="spice_session_disconnect ()" link="SpiceSession.html#spice-session-disconnect"/> + <keyword type="function" name="spice_session_get_channels ()" link="SpiceSession.html#spice-session-get-channels"/> + <keyword type="function" name="spice_session_get_read_only ()" link="SpiceSession.html#spice-session-get-read-only"/> + <keyword type="function" name="spice_session_has_channel_type ()" link="SpiceSession.html#spice-session-has-channel-type"/> + <keyword type="function" name="spice_session_get_proxy_uri ()" link="SpiceSession.html#spice-session-get-proxy-uri" since="0.24"/> + <keyword type="function" name="spice_session_is_for_migration ()" link="SpiceSession.html#spice-session-is-for-migration" since="0.27"/> + <keyword type="function" name="spice_get_option_group ()" link="SpiceSession.html#spice-get-option-group"/> + <keyword type="function" name="spice_set_session_option ()" link="SpiceSession.html#spice-set-session-option"/> + <keyword type="function" name="spice_client_error_quark ()" link="SpiceSession.html#spice-client-error-quark"/> + <keyword type="struct" name="SpiceSession" link="SpiceSession.html#SpiceSession-struct"/> + <keyword type="struct" name="SpiceSessionClass" link="SpiceSession.html#SpiceSessionClass"/> + <keyword type="enum" name="enum SpiceSessionMigration" link="SpiceSession.html#SpiceSessionMigration"/> + <keyword type="enum" name="enum SpiceSessionVerify" link="SpiceSession.html#SpiceSessionVerify"/> + <keyword type="enum" name="enum SpiceClientError" link="SpiceSession.html#SpiceClientError"/> + <keyword type="macro" name="SPICE_CLIENT_ERROR" link="SpiceSession.html#SPICE-CLIENT-ERROR:CAPS"/> + <keyword type="property" name="The “ca” property" link="SpiceSession.html#SpiceSession--ca"/> + <keyword type="property" name="The “ca-file” property" link="SpiceSession.html#SpiceSession--ca-file"/> + <keyword type="property" name="The “cache-size” property" link="SpiceSession.html#SpiceSession--cache-size"/> + <keyword type="property" name="The “cert-subject” property" link="SpiceSession.html#SpiceSession--cert-subject"/> + <keyword type="property" name="The “ciphers” property" link="SpiceSession.html#SpiceSession--ciphers"/> + <keyword type="property" name="The “client-sockets” property" link="SpiceSession.html#SpiceSession--client-sockets"/> + <keyword type="property" name="The “color-depth” property" link="SpiceSession.html#SpiceSession--color-depth"/> + <keyword type="property" name="The “disable-effects” property" link="SpiceSession.html#SpiceSession--disable-effects"/> + <keyword type="property" name="The “enable-audio” property" link="SpiceSession.html#SpiceSession--enable-audio"/> + <keyword type="property" name="The “enable-smartcard” property" link="SpiceSession.html#SpiceSession--enable-smartcard"/> + <keyword type="property" name="The “enable-usbredir” property" link="SpiceSession.html#SpiceSession--enable-usbredir"/> + <keyword type="property" name="The “glz-window-size” property" link="SpiceSession.html#SpiceSession--glz-window-size"/> + <keyword type="property" name="The “host” property" link="SpiceSession.html#SpiceSession--host"/> + <keyword type="property" name="The “inhibit-keyboard-grab” property" link="SpiceSession.html#SpiceSession--inhibit-keyboard-grab"/> + <keyword type="property" name="The “migration-state” property" link="SpiceSession.html#SpiceSession--migration-state"/> + <keyword type="property" name="The “name” property" link="SpiceSession.html#SpiceSession--name"/> + <keyword type="property" name="The “password” property" link="SpiceSession.html#SpiceSession--password"/> + <keyword type="property" name="The “port” property" link="SpiceSession.html#SpiceSession--port"/> + <keyword type="property" name="The “preferred-compression” property" link="SpiceSession.html#SpiceSession--preferred-compression"/> + <keyword type="property" name="The “protocol” property" link="SpiceSession.html#SpiceSession--protocol"/> + <keyword type="property" name="The “proxy” property" link="SpiceSession.html#SpiceSession--proxy"/> + <keyword type="property" name="The “pubkey” property" link="SpiceSession.html#SpiceSession--pubkey"/> + <keyword type="property" name="The “read-only” property" link="SpiceSession.html#SpiceSession--read-only"/> + <keyword type="property" name="The “secure-channels” property" link="SpiceSession.html#SpiceSession--secure-channels"/> + <keyword type="property" name="The “share-dir-ro” property" link="SpiceSession.html#SpiceSession--share-dir-ro"/> + <keyword type="property" name="The “shared-dir” property" link="SpiceSession.html#SpiceSession--shared-dir"/> + <keyword type="property" name="The “smartcard-certificates” property" link="SpiceSession.html#SpiceSession--smartcard-certificates"/> + <keyword type="property" name="The “smartcard-db” property" link="SpiceSession.html#SpiceSession--smartcard-db"/> + <keyword type="property" name="The “tls-port” property" link="SpiceSession.html#SpiceSession--tls-port"/> + <keyword type="property" name="The “unix-path” property" link="SpiceSession.html#SpiceSession--unix-path"/> + <keyword type="property" name="The “uri” property" link="SpiceSession.html#SpiceSession--uri"/> + <keyword type="property" name="The “username” property" link="SpiceSession.html#SpiceSession--username"/> + <keyword type="property" name="The “uuid” property" link="SpiceSession.html#SpiceSession--uuid"/> + <keyword type="property" name="The “verify” property" link="SpiceSession.html#SpiceSession--verify"/> + <keyword type="signal" name="The “channel-destroy” signal" link="SpiceSession.html#SpiceSession-channel-destroy"/> + <keyword type="signal" name="The “channel-new” signal" link="SpiceSession.html#SpiceSession-channel-new"/> + <keyword type="signal" name="The “mm-time-reset” signal" link="SpiceSession.html#SpiceSession-mm-time-reset"/> + <keyword type="function" name="spice_channel_new ()" link="SpiceChannel.html#spice-channel-new"/> + <keyword type="function" name="spice_channel_destroy ()" link="SpiceChannel.html#spice-channel-destroy" deprecated=""/> + <keyword type="function" name="spice_channel_connect ()" link="SpiceChannel.html#spice-channel-connect"/> + <keyword type="function" name="spice_channel_open_fd ()" link="SpiceChannel.html#spice-channel-open-fd"/> + <keyword type="function" name="spice_channel_disconnect ()" link="SpiceChannel.html#spice-channel-disconnect"/> + <keyword type="function" name="spice_channel_test_capability ()" link="SpiceChannel.html#spice-channel-test-capability"/> + <keyword type="function" name="spice_channel_test_common_capability ()" link="SpiceChannel.html#spice-channel-test-common-capability"/> + <keyword type="function" name="spice_channel_type_to_string ()" link="SpiceChannel.html#spice-channel-type-to-string" since="0.20"/> + <keyword type="function" name="spice_channel_string_to_type ()" link="SpiceChannel.html#spice-channel-string-to-type" since="0.21"/> + <keyword type="function" name="spice_channel_set_capability ()" link="SpiceChannel.html#spice-channel-set-capability" deprecated="0.13: this function has been removed"/> + <keyword type="function" name="spice_channel_flush_async ()" link="SpiceChannel.html#spice-channel-flush-async" since="0.15"/> + <keyword type="function" name="spice_channel_flush_finish ()" link="SpiceChannel.html#spice-channel-flush-finish" since="0.15"/> + <keyword type="function" name="spice_channel_get_error ()" link="SpiceChannel.html#spice-channel-get-error" since="0.24"/> + <keyword type="enum" name="enum SpiceChannelEvent" link="SpiceChannel.html#SpiceChannelEvent"/> + <keyword type="struct" name="SpiceChannel" link="SpiceChannel.html#SpiceChannel-struct"/> + <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 “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"/> + <keyword type="signal" name="The “open-fd” signal" link="SpiceChannel.html#SpiceChannel-open-fd"/> + <keyword type="struct" name="struct SpiceCursorChannel" link="SpiceCursorChannel.html#SpiceCursorChannel-struct"/> + <keyword type="struct" name="struct SpiceCursorChannelClass" link="SpiceCursorChannel.html#SpiceCursorChannelClass"/> + <keyword type="signal" name="The “cursor-hide” signal" link="SpiceCursorChannel.html#SpiceCursorChannel-cursor-hide"/> + <keyword type="signal" name="The “cursor-move” signal" link="SpiceCursorChannel.html#SpiceCursorChannel-cursor-move"/> + <keyword type="signal" name="The “cursor-reset” signal" link="SpiceCursorChannel.html#SpiceCursorChannel-cursor-reset"/> + <keyword type="signal" name="The “cursor-set” signal" link="SpiceCursorChannel.html#SpiceCursorChannel-cursor-set"/> + <keyword type="function" name="spice_display_get_primary ()" link="SpiceDisplayChannel.html#spice-display-get-primary"/> + <keyword type="struct" name="struct SpiceDisplayChannel" link="SpiceDisplayChannel.html#SpiceDisplayChannel-struct"/> + <keyword type="struct" name="struct SpiceDisplayChannelClass" link="SpiceDisplayChannel.html#SpiceDisplayChannelClass"/> + <keyword type="property" name="The “height” property" link="SpiceDisplayChannel.html#SpiceDisplayChannel--height"/> + <keyword type="property" name="The “monitors” property" link="SpiceDisplayChannel.html#SpiceDisplayChannel--monitors"/> + <keyword type="property" name="The “monitors-max” property" link="SpiceDisplayChannel.html#SpiceDisplayChannel--monitors-max"/> + <keyword type="property" name="The “width” property" link="SpiceDisplayChannel.html#SpiceDisplayChannel--width"/> + <keyword type="signal" name="The “display-invalidate” signal" link="SpiceDisplayChannel.html#SpiceDisplayChannel-display-invalidate"/> + <keyword type="signal" name="The “display-mark” signal" link="SpiceDisplayChannel.html#SpiceDisplayChannel-display-mark"/> + <keyword type="signal" name="The “display-primary-create” signal" link="SpiceDisplayChannel.html#SpiceDisplayChannel-display-primary-create"/> + <keyword type="signal" name="The “display-primary-destroy” signal" link="SpiceDisplayChannel.html#SpiceDisplayChannel-display-primary-destroy"/> + <keyword type="function" name="spice_inputs_motion ()" link="SpiceInputsChannel.html#spice-inputs-motion"/> + <keyword type="function" name="spice_inputs_position ()" link="SpiceInputsChannel.html#spice-inputs-position"/> + <keyword type="function" name="spice_inputs_button_press ()" link="SpiceInputsChannel.html#spice-inputs-button-press"/> + <keyword type="function" name="spice_inputs_button_release ()" link="SpiceInputsChannel.html#spice-inputs-button-release"/> + <keyword type="function" name="spice_inputs_key_press ()" link="SpiceInputsChannel.html#spice-inputs-key-press"/> + <keyword type="function" name="spice_inputs_key_press_and_release ()" link="SpiceInputsChannel.html#spice-inputs-key-press-and-release" since="0.13"/> + <keyword type="function" name="spice_inputs_key_release ()" link="SpiceInputsChannel.html#spice-inputs-key-release"/> + <keyword type="function" name="spice_inputs_set_key_locks ()" link="SpiceInputsChannel.html#spice-inputs-set-key-locks"/> + <keyword type="struct" name="struct SpiceInputsChannel" link="SpiceInputsChannel.html#SpiceInputsChannel-struct"/> + <keyword type="struct" name="struct SpiceInputsChannelClass" link="SpiceInputsChannel.html#SpiceInputsChannelClass"/> + <keyword type="enum" name="enum SpiceInputsLock" link="SpiceInputsChannel.html#SpiceInputsLock"/> + <keyword type="property" name="The “key-modifiers” property" link="SpiceInputsChannel.html#SpiceInputsChannel--key-modifiers"/> + <keyword type="signal" name="The “inputs-modifiers” signal" link="SpiceInputsChannel.html#SpiceInputsChannel-inputs-modifiers"/> + <keyword type="function" name="spice_main_set_display ()" link="SpiceMainChannel.html#spice-main-set-display"/> + <keyword type="function" name="spice_main_set_display_enabled ()" link="SpiceMainChannel.html#spice-main-set-display-enabled" since="0.6"/> + <keyword type="function" name="spice_main_update_display ()" link="SpiceMainChannel.html#spice-main-update-display"/> + <keyword type="function" name="spice_main_update_display_enabled ()" link="SpiceMainChannel.html#spice-main-update-display-enabled" since="0.30"/> + <keyword type="function" name="spice_main_send_monitor_config ()" link="SpiceMainChannel.html#spice-main-send-monitor-config"/> + <keyword type="function" name="spice_main_agent_test_capability ()" link="SpiceMainChannel.html#spice-main-agent-test-capability"/> + <keyword type="function" name="spice_main_clipboard_selection_grab ()" link="SpiceMainChannel.html#spice-main-clipboard-selection-grab" since="0.6"/> + <keyword type="function" name="spice_main_clipboard_selection_notify ()" link="SpiceMainChannel.html#spice-main-clipboard-selection-notify" since="0.6"/> + <keyword type="function" name="spice_main_clipboard_selection_release ()" link="SpiceMainChannel.html#spice-main-clipboard-selection-release" since="0.6"/> + <keyword type="function" name="spice_main_clipboard_selection_request ()" link="SpiceMainChannel.html#spice-main-clipboard-selection-request" since="0.6"/> + <keyword type="function" name="spice_main_clipboard_grab ()" link="SpiceMainChannel.html#spice-main-clipboard-grab" deprecated="0.6: use spice_main_clipboard_selection_grab() instead."/> + <keyword type="function" name="spice_main_clipboard_release ()" link="SpiceMainChannel.html#spice-main-clipboard-release" deprecated="0.6: use spice_main_clipboard_selection_release() instead."/> + <keyword type="function" name="spice_main_clipboard_notify ()" link="SpiceMainChannel.html#spice-main-clipboard-notify" deprecated="0.6: use spice_main_clipboard_selection_notify() instead."/> + <keyword type="function" name="spice_main_clipboard_request ()" link="SpiceMainChannel.html#spice-main-clipboard-request" deprecated="0.6: use spice_main_clipboard_selection_request() instead."/> + <keyword type="function" name="spice_main_file_copy_async ()" link="SpiceMainChannel.html#spice-main-file-copy-async"/> + <keyword type="function" name="spice_main_file_copy_finish ()" link="SpiceMainChannel.html#spice-main-file-copy-finish"/> + <keyword type="struct" name="struct SpiceMainChannel" link="SpiceMainChannel.html#SpiceMainChannel-struct"/> + <keyword type="struct" name="struct SpiceMainChannelClass" link="SpiceMainChannel.html#SpiceMainChannelClass"/> + <keyword type="property" name="The “agent-caps-0” property" link="SpiceMainChannel.html#SpiceMainChannel--agent-caps-0"/> + <keyword type="property" name="The “agent-connected” property" link="SpiceMainChannel.html#SpiceMainChannel--agent-connected"/> + <keyword type="property" name="The “color-depth” property" link="SpiceMainChannel.html#SpiceMainChannel--color-depth"/> + <keyword type="property" name="The “disable-animation” property" link="SpiceMainChannel.html#SpiceMainChannel--disable-animation"/> + <keyword type="property" name="The “disable-display-align” property" link="SpiceMainChannel.html#SpiceMainChannel--disable-display-align"/> + <keyword type="property" name="The “disable-display-position” property" link="SpiceMainChannel.html#SpiceMainChannel--disable-display-position"/> + <keyword type="property" name="The “disable-font-smooth” property" link="SpiceMainChannel.html#SpiceMainChannel--disable-font-smooth"/> + <keyword type="property" name="The “disable-wallpaper” property" link="SpiceMainChannel.html#SpiceMainChannel--disable-wallpaper"/> + <keyword type="property" name="The “max-clipboard” property" link="SpiceMainChannel.html#SpiceMainChannel--max-clipboard"/> + <keyword type="property" name="The “mouse-mode” property" link="SpiceMainChannel.html#SpiceMainChannel--mouse-mode"/> + <keyword type="signal" name="The “main-agent-update” signal" link="SpiceMainChannel.html#SpiceMainChannel-main-agent-update"/> + <keyword type="signal" name="The “main-clipboard” signal" link="SpiceMainChannel.html#SpiceMainChannel-main-clipboard"/> + <keyword type="signal" name="The “main-clipboard-grab” signal" link="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-grab"/> + <keyword type="signal" name="The “main-clipboard-release” signal" link="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-release"/> + <keyword type="signal" name="The “main-clipboard-request” signal" link="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-request"/> + <keyword type="signal" name="The “main-clipboard-selection” signal" link="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-selection"/> + <keyword type="signal" name="The “main-clipboard-selection-grab” signal" link="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-selection-grab"/> + <keyword type="signal" name="The “main-clipboard-selection-release” signal" link="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-selection-release"/> + <keyword type="signal" name="The “main-clipboard-selection-request” signal" link="SpiceMainChannel.html#SpiceMainChannel-main-clipboard-selection-request"/> + <keyword type="signal" name="The “main-mouse-update” signal" link="SpiceMainChannel.html#SpiceMainChannel-main-mouse-update"/> + <keyword type="signal" name="The “migration-started” signal" link="SpiceMainChannel.html#SpiceMainChannel-migration-started"/> + <keyword type="signal" name="The “new-file-transfer” signal" link="SpiceMainChannel.html#SpiceMainChannel-new-file-transfer"/> + <keyword type="function" name="spice_playback_channel_set_delay ()" link="SpicePlaybackChannel.html#spice-playback-channel-set-delay"/> + <keyword type="struct" name="struct SpicePlaybackChannel" link="SpicePlaybackChannel.html#SpicePlaybackChannel-struct"/> + <keyword type="struct" name="struct SpicePlaybackChannelClass" link="SpicePlaybackChannel.html#SpicePlaybackChannelClass"/> + <keyword type="property" name="The “min-latency” property" link="SpicePlaybackChannel.html#SpicePlaybackChannel--min-latency"/> + <keyword type="property" name="The “mute” property" link="SpicePlaybackChannel.html#SpicePlaybackChannel--mute"/> + <keyword type="property" name="The “nchannels” property" link="SpicePlaybackChannel.html#SpicePlaybackChannel--nchannels"/> + <keyword type="property" name="The “volume” property" link="SpicePlaybackChannel.html#SpicePlaybackChannel--volume"/> + <keyword type="signal" name="The “playback-data” signal" link="SpicePlaybackChannel.html#SpicePlaybackChannel-playback-data"/> + <keyword type="signal" name="The “playback-get-delay” signal" link="SpicePlaybackChannel.html#SpicePlaybackChannel-playback-get-delay"/> + <keyword type="signal" name="The “playback-start” signal" link="SpicePlaybackChannel.html#SpicePlaybackChannel-playback-start"/> + <keyword type="signal" name="The “playback-stop” signal" link="SpicePlaybackChannel.html#SpicePlaybackChannel-playback-stop"/> + <keyword type="function" name="spice_record_send_data ()" link="SpiceRecordChannel.html#spice-record-send-data"/> + <keyword type="struct" name="struct SpiceRecordChannel" link="SpiceRecordChannel.html#SpiceRecordChannel-struct"/> + <keyword type="struct" name="struct SpiceRecordChannelClass" link="SpiceRecordChannel.html#SpiceRecordChannelClass"/> + <keyword type="property" name="The “mute” property" link="SpiceRecordChannel.html#SpiceRecordChannel--mute"/> + <keyword type="property" name="The “nchannels” property" link="SpiceRecordChannel.html#SpiceRecordChannel--nchannels"/> + <keyword type="property" name="The “volume” property" link="SpiceRecordChannel.html#SpiceRecordChannel--volume"/> + <keyword type="signal" name="The “record-start” signal" link="SpiceRecordChannel.html#SpiceRecordChannel-record-start"/> + <keyword type="signal" name="The “record-stop” signal" link="SpiceRecordChannel.html#SpiceRecordChannel-record-stop"/> + <keyword type="struct" name="struct SpiceSmartcardChannel" link="SpiceSmartcardChannel.html#SpiceSmartcardChannel-struct"/> + <keyword type="struct" name="struct SpiceSmartcardChannelClass" link="SpiceSmartcardChannel.html#SpiceSmartcardChannelClass"/> + <keyword type="struct" name="struct SpiceUsbredirChannel" link="SpiceUsbredirChannel.html#SpiceUsbredirChannel-struct"/> + <keyword type="struct" name="struct SpiceUsbredirChannelClass" link="SpiceUsbredirChannel.html#SpiceUsbredirChannelClass"/> + <keyword type="function" name="spice_port_event ()" link="SpicePortChannel.html#spice-port-event" since="0.15"/> + <keyword type="function" name="spice_port_write_async ()" link="SpicePortChannel.html#spice-port-write-async" since="0.15"/> + <keyword type="function" name="spice_port_write_finish ()" link="SpicePortChannel.html#spice-port-write-finish" since="0.15"/> + <keyword type="struct" name="struct SpicePortChannel" link="SpicePortChannel.html#SpicePortChannel-struct"/> + <keyword type="struct" name="struct SpicePortChannelClass" link="SpicePortChannel.html#SpicePortChannelClass"/> + <keyword type="property" name="The “port-name” property" link="SpicePortChannel.html#SpicePortChannel--port-name"/> + <keyword type="property" name="The “port-opened” property" link="SpicePortChannel.html#SpicePortChannel--port-opened"/> + <keyword type="signal" name="The “port-data” signal" link="SpicePortChannel.html#SpicePortChannel-port-data"/> + <keyword type="signal" name="The “port-event” signal" link="SpicePortChannel.html#SpicePortChannel-port-event"/> + <keyword type="struct" name="struct SpiceWebdavChannel" link="SpiceWebdavChannel.html#SpiceWebdavChannel-struct"/> + <keyword type="struct" name="struct SpiceWebdavChannelClass" link="SpiceWebdavChannel.html#SpiceWebdavChannelClass"/> + <keyword type="function" name="spice_gtk_session_get ()" link="SpiceGtkSession.html#spice-gtk-session-get"/> + <keyword type="function" name="spice_gtk_session_copy_to_guest ()" link="SpiceGtkSession.html#spice-gtk-session-copy-to-guest"/> + <keyword type="function" name="spice_gtk_session_paste_from_guest ()" link="SpiceGtkSession.html#spice-gtk-session-paste-from-guest"/> + <keyword type="struct" name="struct SpiceGtkSession" link="SpiceGtkSession.html#SpiceGtkSession-struct"/> + <keyword type="struct" name="struct SpiceGtkSessionClass" link="SpiceGtkSession.html#SpiceGtkSessionClass"/> + <keyword type="property" name="The “auto-clipboard” property" link="SpiceGtkSession.html#SpiceGtkSession--auto-clipboard"/> + <keyword type="property" name="The “auto-usbredir” property" link="SpiceGtkSession.html#SpiceGtkSession--auto-usbredir"/> + <keyword type="property" name="The “pointer-grabbed” property" link="SpiceGtkSession.html#SpiceGtkSession--pointer-grabbed"/> + <keyword type="property" name="The “session” property" link="SpiceGtkSession.html#SpiceGtkSession--session"/> + <keyword type="function" name="spice_display_new ()" link="SpiceDisplay.html#spice-display-new"/> + <keyword type="function" name="spice_display_new_with_monitor ()" link="SpiceDisplay.html#spice-display-new-with-monitor" since="0.13"/> + <keyword type="function" name="spice_display_mouse_ungrab ()" link="SpiceDisplay.html#spice-display-mouse-ungrab"/> + <keyword type="function" name="spice_display_copy_to_guest ()" link="SpiceDisplay.html#spice-display-copy-to-guest" deprecated="0.8: Use spice_gtk_session_copy_to_guest() instead"/> + <keyword type="function" name="spice_display_paste_from_guest ()" link="SpiceDisplay.html#spice-display-paste-from-guest" deprecated="0.8: Use spice_gtk_session_paste_from_guest() instead"/> + <keyword type="function" name="spice_display_set_grab_keys ()" link="SpiceDisplay.html#spice-display-set-grab-keys"/> + <keyword type="function" name="spice_display_get_grab_keys ()" link="SpiceDisplay.html#spice-display-get-grab-keys"/> + <keyword type="function" name="spice_display_send_keys ()" link="SpiceDisplay.html#spice-display-send-keys"/> + <keyword type="function" name="spice_display_get_pixbuf ()" link="SpiceDisplay.html#spice-display-get-pixbuf"/> + <keyword type="function" name="spice_grab_sequence_new ()" link="SpiceDisplay.html#spice-grab-sequence-new"/> + <keyword type="function" name="spice_grab_sequence_new_from_string ()" link="SpiceDisplay.html#spice-grab-sequence-new-from-string"/> + <keyword type="function" name="spice_grab_sequence_copy ()" link="SpiceDisplay.html#spice-grab-sequence-copy"/> + <keyword type="function" name="spice_grab_sequence_free ()" link="SpiceDisplay.html#spice-grab-sequence-free"/> + <keyword type="function" name="spice_grab_sequence_as_string ()" link="SpiceDisplay.html#spice-grab-sequence-as-string"/> + <keyword type="struct" name="struct SpiceDisplay" link="SpiceDisplay.html#SpiceDisplay-struct"/> + <keyword type="struct" name="struct SpiceDisplayClass" link="SpiceDisplay.html#SpiceDisplayClass"/> + <keyword type="enum" name="enum SpiceDisplayKeyEvent" link="SpiceDisplay.html#SpiceDisplayKeyEvent"/> + <keyword type="struct" name="struct SpiceGrabSequence" link="SpiceDisplay.html#SpiceGrabSequence-struct"/> + <keyword type="property" name="The “auto-clipboard” property" link="SpiceDisplay.html#SpiceDisplay--auto-clipboard"/> + <keyword type="property" name="The “channel-id” property" link="SpiceDisplay.html#SpiceDisplay--channel-id"/> + <keyword type="property" name="The “disable-inputs” property" link="SpiceDisplay.html#SpiceDisplay--disable-inputs"/> + <keyword type="property" name="The “grab-keyboard” property" link="SpiceDisplay.html#SpiceDisplay--grab-keyboard"/> + <keyword type="property" name="The “grab-mouse” property" link="SpiceDisplay.html#SpiceDisplay--grab-mouse"/> + <keyword type="property" name="The “keypress-delay” property" link="SpiceDisplay.html#SpiceDisplay--keypress-delay"/> + <keyword type="property" name="The “monitor-id” property" link="SpiceDisplay.html#SpiceDisplay--monitor-id"/> + <keyword type="property" name="The “only-downscale” property" link="SpiceDisplay.html#SpiceDisplay--only-downscale"/> + <keyword type="property" name="The “ready” property" link="SpiceDisplay.html#SpiceDisplay--ready"/> + <keyword type="property" name="The “resize-guest” property" link="SpiceDisplay.html#SpiceDisplay--resize-guest"/> + <keyword type="property" name="The “scaling” property" link="SpiceDisplay.html#SpiceDisplay--scaling"/> + <keyword type="property" name="The “session” property" link="SpiceDisplay.html#SpiceDisplay--session"/> + <keyword type="property" name="The “zoom-level” property" link="SpiceDisplay.html#SpiceDisplay--zoom-level"/> + <keyword type="signal" name="The “grab-keys-pressed” signal" link="SpiceDisplay.html#SpiceDisplay-grab-keys-pressed"/> + <keyword type="signal" name="The “keyboard-grab” signal" link="SpiceDisplay.html#SpiceDisplay-keyboard-grab"/> + <keyword type="signal" name="The “mouse-grab” signal" link="SpiceDisplay.html#SpiceDisplay-mouse-grab"/> + <keyword type="function" name="spice_usb_device_widget_new ()" link="SpiceUsbDeviceWidget.html#spice-usb-device-widget-new"/> + <keyword type="struct" name="struct SpiceUsbDeviceWidget" link="SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget-struct"/> + <keyword type="struct" name="struct SpiceUsbDeviceWidgetClass" link="SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidgetClass"/> + <keyword type="property" name="The “device-format-string” property" link="SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget--device-format-string"/> + <keyword type="property" name="The “session” property" link="SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget--session"/> + <keyword type="signal" name="The “connect-failed” signal" link="SpiceUsbDeviceWidget.html#SpiceUsbDeviceWidget-connect-failed"/> + <keyword type="function" name="spice_audio_get ()" link="SpiceAudio.html#spice-audio-get"/> + <keyword type="function" name="spice_audio_new ()" link="SpiceAudio.html#spice-audio-new" deprecated="0.8: Use spice_audio_get() instead"/> + <keyword type="struct" name="struct SpiceAudio" link="SpiceAudio.html#SpiceAudio-struct"/> + <keyword type="struct" name="struct SpiceAudioClass" link="SpiceAudio.html#SpiceAudioClass"/> + <keyword type="property" name="The “main-context” property" link="SpiceAudio.html#SpiceAudio--main-context"/> + <keyword type="property" name="The “session” property" link="SpiceAudio.html#SpiceAudio--session"/> + <keyword type="function" name="spice_smartcard_manager_get ()" link="SpiceSmartcardManager.html#spice-smartcard-manager-get"/> + <keyword type="function" name="spice_smartcard_manager_get_readers ()" link="SpiceSmartcardManager.html#spice-smartcard-manager-get-readers" since="0.20"/> + <keyword type="function" name="spice_smartcard_manager_insert_card ()" link="SpiceSmartcardManager.html#spice-smartcard-manager-insert-card" since="0.20"/> + <keyword type="function" name="spice_smartcard_manager_remove_card ()" link="SpiceSmartcardManager.html#spice-smartcard-manager-remove-card" since="0.20"/> + <keyword type="function" name="spice_smartcard_reader_is_software ()" link="SpiceSmartcardManager.html#spice-smartcard-reader-is-software"/> + <keyword type="function" name="spice_smartcard_reader_insert_card ()" link="SpiceSmartcardManager.html#spice-smartcard-reader-insert-card"/> + <keyword type="function" name="spice_smartcard_reader_remove_card ()" link="SpiceSmartcardManager.html#spice-smartcard-reader-remove-card"/> + <keyword type="struct" name="struct SpiceSmartcardManager" link="SpiceSmartcardManager.html#SpiceSmartcardManager-struct"/> + <keyword type="struct" name="struct SpiceSmartcardManagerClass" link="SpiceSmartcardManager.html#SpiceSmartcardManagerClass"/> + <keyword type="struct" name="SpiceSmartcardReader" link="SpiceSmartcardManager.html#SpiceSmartcardReader"/> + <keyword type="signal" name="The “card-inserted” signal" link="SpiceSmartcardManager.html#SpiceSmartcardManager-card-inserted"/> + <keyword type="signal" name="The “card-removed” signal" link="SpiceSmartcardManager.html#SpiceSmartcardManager-card-removed"/> + <keyword type="signal" name="The “reader-added” signal" link="SpiceSmartcardManager.html#SpiceSmartcardManager-reader-added"/> + <keyword type="signal" name="The “reader-removed” signal" link="SpiceSmartcardManager.html#SpiceSmartcardManager-reader-removed"/> + <keyword type="function" name="spice_usb_device_manager_get ()" link="SpiceUsbDeviceManager.html#spice-usb-device-manager-get"/> + <keyword type="function" name="spice_usb_device_manager_get_devices ()" link="SpiceUsbDeviceManager.html#spice-usb-device-manager-get-devices"/> + <keyword type="function" name="spice_usb_device_manager_get_devices_with_filter ()" link="SpiceUsbDeviceManager.html#spice-usb-device-manager-get-devices-with-filter" since="0.20"/> + <keyword type="function" name="spice_usb_device_manager_is_device_connected ()" link="SpiceUsbDeviceManager.html#spice-usb-device-manager-is-device-connected"/> + <keyword type="function" name="spice_usb_device_manager_disconnect_device ()" link="SpiceUsbDeviceManager.html#spice-usb-device-manager-disconnect-device"/> + <keyword type="function" name="spice_usb_device_manager_can_redirect_device ()" link="SpiceUsbDeviceManager.html#spice-usb-device-manager-can-redirect-device"/> + <keyword type="function" name="spice_usb_device_manager_connect_device_async ()" link="SpiceUsbDeviceManager.html#spice-usb-device-manager-connect-device-async"/> + <keyword type="function" name="spice_usb_device_manager_connect_device_finish ()" link="SpiceUsbDeviceManager.html#spice-usb-device-manager-connect-device-finish"/> + <keyword type="function" name="spice_usb_device_get_description ()" link="SpiceUsbDeviceManager.html#spice-usb-device-get-description"/> + <keyword type="function" name="spice_usb_device_get_libusb_device ()" link="SpiceUsbDeviceManager.html#spice-usb-device-get-libusb-device" since="0.27"/> + <keyword type="struct" name="struct SpiceUsbDeviceManager" link="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-struct"/> + <keyword type="struct" name="struct SpiceUsbDeviceManagerClass" link="SpiceUsbDeviceManager.html#SpiceUsbDeviceManagerClass"/> + <keyword type="struct" name="SpiceUsbDevice" link="SpiceUsbDeviceManager.html#SpiceUsbDevice-struct"/> + <keyword type="property" name="The “auto-connect” property" link="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager--auto-connect"/> + <keyword type="property" name="The “auto-connect-filter” property" link="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager--auto-connect-filter"/> + <keyword type="property" name="The “redirect-on-connect” property" link="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager--redirect-on-connect"/> + <keyword type="property" name="The “session” property" link="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager--session"/> + <keyword type="signal" name="The “auto-connect-failed” signal" link="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-auto-connect-failed"/> + <keyword type="signal" name="The “device-added” signal" link="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-device-added"/> + <keyword type="signal" name="The “device-error” signal" link="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-device-error"/> + <keyword type="signal" name="The “device-removed” signal" link="SpiceUsbDeviceManager.html#SpiceUsbDeviceManager-device-removed"/> + <keyword type="function" name="spice_util_set_debug ()" link="spice-gtk-Utilities.html#spice-util-set-debug"/> + <keyword type="function" name="spice_util_get_version_string ()" link="spice-gtk-Utilities.html#spice-util-get-version-string"/> + <keyword type="function" name="spice_uuid_to_string ()" link="spice-gtk-Utilities.html#spice-uuid-to-string" since="0.22"/> + <keyword type="macro" name="SPICE_GTK_CHECK_VERSION()" link="spice-gtk-Version-Information.html#SPICE-GTK-CHECK-VERSION:CAPS" since="0.24"/> + <keyword type="macro" name="SPICE_GTK_MAJOR_VERSION" link="spice-gtk-Version-Information.html#SPICE-GTK-MAJOR-VERSION:CAPS" since="0.24"/> + <keyword type="macro" name="SPICE_GTK_MICRO_VERSION" link="spice-gtk-Version-Information.html#SPICE-GTK-MICRO-VERSION:CAPS" since="0.24"/> + <keyword type="macro" name="SPICE_GTK_MINOR_VERSION" link="spice-gtk-Version-Information.html#SPICE-GTK-MINOR-VERSION:CAPS" since="0.24"/> + <keyword type="function" name="spice_uri_get_scheme ()" link="spice-gtk-SpiceURI.html#spice-uri-get-scheme" since="0.24"/> + <keyword type="function" name="spice_uri_set_scheme ()" link="spice-gtk-SpiceURI.html#spice-uri-set-scheme" since="0.24"/> + <keyword type="function" name="spice_uri_get_hostname ()" link="spice-gtk-SpiceURI.html#spice-uri-get-hostname" since="0.24"/> + <keyword type="function" name="spice_uri_set_hostname ()" link="spice-gtk-SpiceURI.html#spice-uri-set-hostname" since="0.24"/> + <keyword type="function" name="spice_uri_get_port ()" link="spice-gtk-SpiceURI.html#spice-uri-get-port" since="0.24"/> + <keyword type="function" name="spice_uri_set_port ()" link="spice-gtk-SpiceURI.html#spice-uri-set-port" since="0.24"/> + <keyword type="function" name="spice_uri_get_user ()" link="spice-gtk-SpiceURI.html#spice-uri-get-user" since="0.24"/> + <keyword type="function" name="spice_uri_set_user ()" link="spice-gtk-SpiceURI.html#spice-uri-set-user" since="0.24"/> + <keyword type="function" name="spice_uri_get_password ()" link="spice-gtk-SpiceURI.html#spice-uri-get-password" since="0.24"/> + <keyword type="function" name="spice_uri_set_password ()" link="spice-gtk-SpiceURI.html#spice-uri-set-password" since="0.24"/> + <keyword type="function" name="spice_uri_to_string ()" link="spice-gtk-SpiceURI.html#spice-uri-to-string" since="0.24"/> + <keyword type="struct" name="SpiceURIClass" link="spice-gtk-SpiceURI.html#SpiceURIClass"/> + <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"/> + <keyword type="function" name="spice_file_transfer_task_get_filename ()" link="SpiceFileTransferTask.html#spice-file-transfer-task-get-filename"/> + <keyword type="function" name="spice_file_transfer_task_cancel ()" link="SpiceFileTransferTask.html#spice-file-transfer-task-cancel"/> + <keyword type="struct" name="struct SpiceFileTransferTask" link="SpiceFileTransferTask.html#SpiceFileTransferTask-struct"/> + <keyword type="struct" name="struct SpiceFileTransferTaskClass" link="SpiceFileTransferTask.html#SpiceFileTransferTaskClass"/> + <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="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"/> + <keyword type="constant" name="SPICE_SESSION_MIGRATION_MIGRATING" link="SpiceSession.html#SPICE-SESSION-MIGRATION-MIGRATING:CAPS"/> + <keyword type="constant" name="SPICE_SESSION_MIGRATION_CONNECTING" link="SpiceSession.html#SPICE-SESSION-MIGRATION-CONNECTING:CAPS"/> + <keyword type="constant" name="SPICE_SESSION_VERIFY_PUBKEY" link="SpiceSession.html#SPICE-SESSION-VERIFY-PUBKEY:CAPS"/> + <keyword type="constant" name="SPICE_SESSION_VERIFY_HOSTNAME" link="SpiceSession.html#SPICE-SESSION-VERIFY-HOSTNAME:CAPS"/> + <keyword type="constant" name="SPICE_SESSION_VERIFY_SUBJECT" link="SpiceSession.html#SPICE-SESSION-VERIFY-SUBJECT:CAPS"/> + <keyword type="constant" name="SPICE_CLIENT_ERROR_FAILED" link="SpiceSession.html#SPICE-CLIENT-ERROR-FAILED:CAPS"/> + <keyword type="constant" name="SPICE_CLIENT_ERROR_USB_DEVICE_REJECTED" link="SpiceSession.html#SPICE-CLIENT-ERROR-USB-DEVICE-REJECTED:CAPS"/> + <keyword type="constant" name="SPICE_CLIENT_ERROR_USB_DEVICE_LOST" link="SpiceSession.html#SPICE-CLIENT-ERROR-USB-DEVICE-LOST:CAPS"/> + <keyword type="constant" name="SPICE_CLIENT_ERROR_AUTH_NEEDS_PASSWORD" link="SpiceSession.html#SPICE-CLIENT-ERROR-AUTH-NEEDS-PASSWORD:CAPS"/> + <keyword type="constant" name="SPICE_CLIENT_ERROR_AUTH_NEEDS_PASSWORD_AND_USERNAME" link="SpiceSession.html#SPICE-CLIENT-ERROR-AUTH-NEEDS-PASSWORD-AND-USERNAME:CAPS"/> + <keyword type="constant" name="SPICE_CLIENT_ERROR_USB_SERVICE" link="SpiceSession.html#SPICE-CLIENT-ERROR-USB-SERVICE:CAPS"/> + <keyword type="constant" name="SPICE_CHANNEL_NONE" link="SpiceChannel.html#SPICE-CHANNEL-NONE:CAPS"/> + <keyword type="constant" name="SPICE_CHANNEL_OPENED" link="SpiceChannel.html#SPICE-CHANNEL-OPENED:CAPS"/> + <keyword type="constant" name="SPICE_CHANNEL_SWITCHING" link="SpiceChannel.html#SPICE-CHANNEL-SWITCHING:CAPS"/> + <keyword type="constant" name="SPICE_CHANNEL_CLOSED" link="SpiceChannel.html#SPICE-CHANNEL-CLOSED:CAPS"/> + <keyword type="constant" name="SPICE_CHANNEL_ERROR_CONNECT" link="SpiceChannel.html#SPICE-CHANNEL-ERROR-CONNECT:CAPS"/> + <keyword type="constant" name="SPICE_CHANNEL_ERROR_TLS" link="SpiceChannel.html#SPICE-CHANNEL-ERROR-TLS:CAPS"/> + <keyword type="constant" name="SPICE_CHANNEL_ERROR_LINK" link="SpiceChannel.html#SPICE-CHANNEL-ERROR-LINK:CAPS"/> + <keyword type="constant" name="SPICE_CHANNEL_ERROR_AUTH" link="SpiceChannel.html#SPICE-CHANNEL-ERROR-AUTH:CAPS"/> + <keyword type="constant" name="SPICE_CHANNEL_ERROR_IO" link="SpiceChannel.html#SPICE-CHANNEL-ERROR-IO:CAPS"/> + <keyword type="constant" name="SPICE_INPUTS_SCROLL_LOCK" link="SpiceInputsChannel.html#SPICE-INPUTS-SCROLL-LOCK:CAPS"/> + <keyword type="constant" name="SPICE_INPUTS_NUM_LOCK" link="SpiceInputsChannel.html#SPICE-INPUTS-NUM-LOCK:CAPS"/> + <keyword type="constant" name="SPICE_INPUTS_CAPS_LOCK" link="SpiceInputsChannel.html#SPICE-INPUTS-CAPS-LOCK:CAPS"/> + <keyword type="constant" name="SPICE_DISPLAY_KEY_EVENT_PRESS" link="SpiceDisplay.html#SPICE-DISPLAY-KEY-EVENT-PRESS:CAPS"/> + <keyword type="constant" name="SPICE_DISPLAY_KEY_EVENT_RELEASE" link="SpiceDisplay.html#SPICE-DISPLAY-KEY-EVENT-RELEASE:CAPS"/> + <keyword type="constant" name="SPICE_DISPLAY_KEY_EVENT_CLICK" link="SpiceDisplay.html#SPICE-DISPLAY-KEY-EVENT-CLICK:CAPS"/> + </functions> +</book> diff --git a/content-extra/api/spice-gtk/style.css b/content-extra/api/spice-gtk/style.css new file mode 100644 index 0000000..3675420 --- /dev/null +++ b/content-extra/api/spice-gtk/style.css @@ -0,0 +1,479 @@ +body +{ + font-family: cantarell, sans-serif; +} +.synopsis, .classsynopsis +{ + /* tango:aluminium 1/2 */ + background: #eeeeec; + background: rgba(238, 238, 236, 0.5); + border: solid 1px rgb(238, 238, 236); + padding: 0.5em; +} +.programlisting +{ + /* tango:sky blue 0/1 */ + /* fallback for no rgba support */ + background: #e6f3ff; + border: solid 1px #729fcf; + background: rgba(114, 159, 207, 0.1); + border: solid 1px rgba(114, 159, 207, 0.2); + padding: 0.5em; +} +.variablelist +{ + padding: 4px; + margin-left: 3em; +} +.variablelist td:first-child +{ + vertical-align: top; +} + +div.gallery-float +{ + float: left; + padding: 10px; +} +div.gallery-float img +{ + border-style: none; +} +div.gallery-spacer +{ + clear: both; +} + +a, a:visited +{ + text-decoration: none; + /* tango:sky blue 2 */ + color: #3465a4; +} +a:hover +{ + text-decoration: underline; + /* tango:sky blue 1 */ + color: #729fcf; +} + +div.informaltable table +{ + border-collapse: separate; + border-spacing: 1em 0.3em; + border: none; +} + +div.informaltable table td, div.informaltable table th +{ + vertical-align: top; +} + +.function_type, +.variable_type, +.property_type, +.signal_type, +.parameter_name, +.struct_member_name, +.union_member_name, +.define_keyword, +.datatype_keyword, +.typedef_keyword +{ + text-align: right; +} + +/* dim non-primary columns */ +.c_punctuation, +.function_type, +.variable_type, +.property_type, +.signal_type, +.define_keyword, +.datatype_keyword, +.typedef_keyword, +.property_flags, +.signal_flags, +.parameter_annotations, +.enum_member_annotations, +.struct_member_annotations, +.union_member_annotations +{ + color: #888a85; +} + +.function_type a, +.function_type a:visited, +.function_type a:hover, +.property_type a, +.property_type a:visited, +.property_type a:hover, +.signal_type a, +.signal_type a:visited, +.signal_type a:hover, +.signal_flags a, +.signal_flags a:visited, +.signal_flags a:hover +{ + color: #729fcf; +} + +td p +{ + margin: 0.25em; +} + +div.table table +{ + border-collapse: collapse; + border-spacing: 0px; + /* tango:aluminium 3 */ + border: solid 1px #babdb6; +} + +div.table table td, div.table table th +{ + /* tango:aluminium 3 */ + border: solid 1px #babdb6; + padding: 3px; + vertical-align: top; +} + +div.table table th +{ + /* tango:aluminium 2 */ + background-color: #d3d7cf; +} + +h4 +{ + color: #555753; + margin-top: 1em; + margin-bottom: 1em; +} + +hr +{ + /* tango:aluminium 1 */ + color: #d3d7cf; + background: #d3d7cf; + border: none 0px; + height: 1px; + clear: both; + margin: 2.0em 0em 2.0em 0em; +} + +dl.toc dt +{ + padding-bottom: 0.25em; +} + +dl.toc > dt +{ + padding-top: 0.25em; + padding-bottom: 0.25em; + font-weight: bold; +} + +dl.toc > dl +{ + padding-bottom: 0.5em; +} + +.parameter +{ + font-style: normal; +} + +.footer +{ + padding-top: 3.5em; + /* tango:aluminium 3 */ + color: #babdb6; + text-align: center; + font-size: 80%; +} + +.informalfigure, +.figure +{ + margin: 1em; +} + +.informalexample, +.example +{ + margin-top: 1em; + margin-bottom: 1em; +} + +.warning +{ + /* tango:orange 0/1 */ + background: #ffeed9; + background: rgba(252, 175, 62, 0.1); + border-color: #ffb04f; + border-color: rgba(252, 175, 62, 0.2); +} +.note +{ + /* tango:chameleon 0/0.5 */ + background: #d8ffb2; + background: rgba(138, 226, 52, 0.1); + border-color: #abf562; + border-color: rgba(138, 226, 52, 0.2); +} +div.blockquote +{ + border-color: #eeeeec; +} +.note, .warning, div.blockquote +{ + padding: 0.5em; + border-width: 1px; + border-style: solid; + margin: 2em; +} +.note p, .warning p +{ + margin: 0; +} + +div.warning h3.title, +div.note h3.title +{ + display: none; +} + +p + div.section +{ + margin-top: 1em; +} + +div.refnamediv, +div.refsynopsisdiv, +div.refsect1, +div.refsect2, +div.toc, +div.section +{ + margin-bottom: 1em; +} + +/* blob links */ +h2 .extralinks, h3 .extralinks +{ + float: right; + /* tango:aluminium 3 */ + color: #babdb6; + font-size: 80%; + font-weight: normal; +} + +.lineart +{ + color: #d3d7cf; + font-weight: normal; +} + +.annotation +{ + /* tango:aluminium 5 */ + color: #555753; + font-weight: normal; +} + +.structfield +{ + font-style: normal; + font-weight: normal; +} + +acronym,abbr +{ + border-bottom: 1px dotted gray; +} + +/* code listings */ + +.listing_code .programlisting .normal, +.listing_code .programlisting .normal a, +.listing_code .programlisting .number, +.listing_code .programlisting .cbracket, +.listing_code .programlisting .symbol { color: #555753; } +.listing_code .programlisting .comment, +.listing_code .programlisting .linenum { color: #babdb6; } /* tango: aluminium 3 */ +.listing_code .programlisting .function, +.listing_code .programlisting .function a, +.listing_code .programlisting .preproc { color: #204a87; } /* tango: sky blue 3 */ +.listing_code .programlisting .string { color: #ad7fa8; } /* tango: plum */ +.listing_code .programlisting .keyword, +.listing_code .programlisting .usertype, +.listing_code .programlisting .type, +.listing_code .programlisting .type a { color: #4e9a06; } /* tango: chameleon 3 */ + +.listing_frame { + /* tango:sky blue 1 */ + border: solid 1px #729fcf; + border: solid 1px rgba(114, 159, 207, 0.2); + padding: 0px; +} + +.listing_lines, .listing_code { + margin-top: 0px; + margin-bottom: 0px; + padding: 0.5em; +} +.listing_lines { + /* tango:sky blue 0.5 */ + background: #a6c5e3; + background: rgba(114, 159, 207, 0.2); + /* tango:aluminium 6 */ + color: #2e3436; +} +.listing_code { + /* tango:sky blue 0 */ + background: #e6f3ff; + background: rgba(114, 159, 207, 0.1); +} +.listing_code .programlisting { + /* override from previous */ + border: none 0px; + padding: 0px; + background: none; +} +.listing_lines pre, .listing_code pre { + margin: 0px; +} + +@media screen { + /* these have a <sup> as a first child, but since there are no parent selectors + * we can't use that. */ + a.footnote + { + position: relative; + top: 0em ! important; + } + /* this is needed so that the local anchors are displayed below the naviagtion */ + div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] + { + display: inline-block; + position: relative; + top:-5em; + } + /* this seems to be a bug in the xsl style sheets when generating indexes */ + div.index div.index + { + top: 0em; + } + /* make space for the fixed navigation bar and add space at the bottom so that + * link targets appear somewhat close to top + */ + body + { + padding-top: 2.5em; + padding-bottom: 500px; + max-width: 60em; + } + p + { + max-width: 60em; + } + /* style and size the navigation bar */ + table.navigation#top + { + position: fixed; + background: #e2e2e2; + border-bottom: solid 1px #babdb6; + border-spacing: 5px; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + z-index: 10; + } + table.navigation#top td + { + padding-left: 6px; + padding-right: 6px; + } + .navigation a, .navigation a:visited + { + /* tango:sky blue 3 */ + color: #204a87; + } + .navigation a:hover + { + /* tango:sky blue 2 */ + color: #3465a4; + } + td.shortcuts + { + /* tango:sky blue 2 */ + color: #3465a4; + font-size: 80%; + white-space: nowrap; + } + td.shortcuts .dim + { + color: #babdb6; + } + .navigation .title + { + font-size: 80%; + max-width: none; + margin: 0px; + font-weight: normal; + } +} +@media screen and (min-width: 60em) { + /* screen larger than 60em */ + body { margin: auto; } +} +@media screen and (max-width: 60em) { + /* screen less than 60em */ + #nav_hierarchy { display: none; } + #nav_interfaces { display: none; } + #nav_prerequisites { display: none; } + #nav_derived_interfaces { display: none; } + #nav_implementations { display: none; } + #nav_child_properties { display: none; } + #nav_style_properties { display: none; } + #nav_index { display: none; } + #nav_glossary { display: none; } + .gallery_image { display: none; } + .property_flags { display: none; } + .signal_flags { display: none; } + .parameter_annotations { display: none; } + .enum_member_annotations { display: none; } + .struct_member_annotations { display: none; } + .union_member_annotations { display: none; } + /* now that a column is hidden, optimize space */ + col.parameters_name { width: auto; } + col.parameters_description { width: auto; } + col.struct_members_name { width: auto; } + col.struct_members_description { width: auto; } + col.enum_members_name { width: auto; } + col.enum_members_description { width: auto; } + col.union_members_name { width: auto; } + col.union_members_description { width: auto; } + .listing_lines { display: none; } +} +@media print { + table.navigation { + visibility: collapse; + display: none; + } + div.titlepage table.navigation { + visibility: visible; + display: table; + background: #e2e2e2; + border: solid 1px #babdb6; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + } +} + diff --git a/content-extra/api/spice-gtk/up-insensitive.png b/content-extra/api/spice-gtk/up-insensitive.png Binary files differnew file mode 100644 index 0000000..f404986 --- /dev/null +++ b/content-extra/api/spice-gtk/up-insensitive.png diff --git a/content-extra/api/spice-gtk/up.png b/content-extra/api/spice-gtk/up.png Binary files differnew file mode 100644 index 0000000..80b4b37 --- /dev/null +++ b/content-extra/api/spice-gtk/up.png diff --git a/content/pages/spice-gtk.rst b/content/pages/spice-gtk.rst new file mode 100644 index 0000000..24a28e0 --- /dev/null +++ b/content/pages/spice-gtk.rst @@ -0,0 +1,50 @@ +spice-gtk +############################################################################### +:slug: spice-gtk +:submenu: documentation +:modified: 2015-11-03 12:00 + +|frame| + +.. |frame| raw:: html + + <script type="text/javascript"> + function getDocHeight(doc) + { + doc = doc || document; + // stackoverflow.com/questions/1145850/ + var body = doc.body, html = doc.documentElement; + var height = Math.max(body.scrollHeight, + body.offsetHeight, + html.clientHeight, + html.scrollHeight, + html.offsetHeight); + return height; + } + + function setIframeHeight(id) + { + var ifrm = document.getElementById(id); + var doc = ifrm.contentDocument ? + ifrm.contentDocument : ifrm.contentWindow.document; + var height = getDocHeight( doc ) + 4 + "px"; + + // It seems that on firefox, ie and chrome, onload behaves + // differently - inner links might not work on firefox. The + // workaround bellow does not work on firefox and it is not + // necessary to chrome. + // if (ifrm.style.height == height) + // return; + + ifrm.style.visibility = 'hidden'; + ifrm.style.height = "10px"; // reset to minimal height ... + // IE opt. for bing/msn needs a bit added or scrollbar appears + ifrm.style.height = getDocHeight( doc ) + 4 + "px"; + ifrm.style.visibility = 'visible'; + } + </script> + <iframe id="ifrm" + width="100%" + src="api/spice-gtk/" + onload="setIframeHeight(this.id)"> + </iframe> |
