One Hat Cyber Team

Edit File: ui.html

<!DOCTYPE html>

 <html class="no-js" lang="en" > 
<head>
 <meta charset="utf-8">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 <title>QEMU UI subsystem &mdash; QEMU qemu-kvm-6.2.0-53.module+el8.10.0+2055+8eb7870b.4 documentation</title>

</head>

<a href="../index.html" class="icon icon-home"> QEMU

</div>

<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
 
 
 
 
 
 
 Contents:
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../about/index.html">About QEMU</a></li>
<li class="toctree-l1"><a class="reference internal" href="../system/index.html">System Emulation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user/index.html">User Mode Emulation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../interop/index.html">System Emulation Management and Interoperability</a></li>
<li class="toctree-l1"><a class="reference internal" href="../specs/index.html">System Emulation Guest Hardware Specifications</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Developer Information</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="code-of-conduct.html">Code of Conduct</a></li>
<li class="toctree-l2"><a class="reference internal" href="conflict-resolution.html">Conflict Resolution Policy</a></li>
<li class="toctree-l2"><a class="reference internal" href="build-system.html">The QEMU build system architecture</a></li>
<li class="toctree-l2"><a class="reference internal" href="style.html">QEMU Coding Style</a></li>
<li class="toctree-l2"><a class="reference internal" href="kconfig.html">QEMU and Kconfig</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html">Testing in QEMU</a></li>
<li class="toctree-l2"><a class="reference internal" href="fuzzing.html">Fuzzing</a></li>
<li class="toctree-l2"><a class="reference internal" href="control-flow-integrity.html">Control-Flow Integrity (CFI)</a></li>
<li class="toctree-l2"><a class="reference internal" href="loads-stores.html">Load and Store APIs</a></li>
<li class="toctree-l2"><a class="reference internal" href="memory.html">The memory API</a></li>
<li class="toctree-l2"><a class="reference internal" href="migration.html">Migration</a></li>
<li class="toctree-l2"><a class="reference internal" href="atomics.html">Atomic operations in QEMU</a></li>
<li class="toctree-l2"><a class="reference internal" href="stable-process.html">QEMU and the stable process</a></li>
<li class="toctree-l2"><a class="reference internal" href="ci.html">CI</a></li>
<li class="toctree-l2"><a class="reference internal" href="qtest.html">QTest Device Emulation Testing Framework</a></li>
<li class="toctree-l2"><a class="reference internal" href="decodetree.html">Decodetree Specification</a></li>
<li class="toctree-l2"><a class="reference internal" href="secure-coding-practices.html">Secure Coding Practices</a></li>
<li class="toctree-l2"><a class="reference internal" href="tcg.html">Translator Internals</a></li>
<li class="toctree-l2"><a class="reference internal" href="tcg-icount.html">TCG Instruction Counting</a></li>
<li class="toctree-l2"><a class="reference internal" href="tracing.html">Tracing</a></li>
<li class="toctree-l2"><a class="reference internal" href="multi-thread-tcg.html">Multi-threaded TCG</a></li>
<li class="toctree-l2"><a class="reference internal" href="tcg-plugins.html">QEMU TCG Plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="bitops.html">Bitwise operations</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">QEMU UI subsystem</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#qemu-clipboard">QEMU Clipboard</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reset.html">Reset in QEMU: the Resettable interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="s390-dasd-ipl.html">Booting from real channel-attached devices on s390x</a></li>
<li class="toctree-l2"><a class="reference internal" href="clocks.html">Modelling a clock tree in QEMU</a></li>
<li class="toctree-l2"><a class="reference internal" href="qom.html">The QEMU Object Model (QOM)</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html">QEMU modules</a></li>
<li class="toctree-l2"><a class="reference internal" href="block-coroutine-wrapper.html">block-coroutine-wrapper</a></li>
<li class="toctree-l2"><a class="reference internal" href="multi-process.html">Multi-process QEMU</a></li>
<li class="toctree-l2"><a class="reference internal" href="ebpf_rss.html">eBPF RSS virtio-net support</a></li>
<li class="toctree-l2"><a class="reference internal" href="vfio-migration.html">VFIO device Migration</a></li>
<li class="toctree-l2"><a class="reference internal" href="qapi-code-gen.html">How to use the QAPI code generator</a></li>
<li class="toctree-l2"><a class="reference internal" href="writing-monitor-commands.html">How to write monitor commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="trivial-patches.html">Trivial Patches</a></li>
<li class="toctree-l2"><a class="reference internal" href="submitting-a-patch.html">Submitting a Patch</a></li>
<li class="toctree-l2"><a class="reference internal" href="submitting-a-pull-request.html">Submitting a Pull Request</a></li>
</ul>
</li>
</ul>

</div>
 </div>
 </nav>

<ul class="wy-breadcrumbs">
 
 <li><a href="../index.html">Docs</a> &raquo;</li>
 
 <li><a href="index.html">Developer Information</a> &raquo;</li>
 
 <li>QEMU UI subsystem</li>
 
 
 <li class="wy-breadcrumbs-aside">
 
 
 
 <a href="https://gitlab.com/qemu-project/qemu/blob/master/docs/devel/ui.rst" class="fa fa-gitlab"> Edit on GitLab</a>
 
 
 
 </li>
 
 </ul>

<hr/>
</div>
 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 <div itemprop="articleBody">
 
 <div class="section" id="qemu-ui-subsystem">
<h1>QEMU UI subsystem<a class="headerlink" href="#qemu-ui-subsystem" title="Permalink to this headline">¶</a></h1>
<div class="section" id="qemu-clipboard">
<h2>QEMU Clipboard<a class="headerlink" href="#qemu-clipboard" title="Permalink to this headline">¶</a></h2>
Introduction
The header <code class="docutils literal notranslate">ui/clipboard.h</code> declares the qemu clipboard interface.
All qemu elements which want use the clipboard can register as
clipboard peer. Subsequently they can set the clipboard content
and get notifications for clipboard updates.
Typical users are user interfaces (gtk), remote access protocols
(vnc) and devices talking to the guest (vdagent).
Even though the design allows different data types only plain text
is supported for now.
<dl class="type">
<dt id="c.QemuClipboardType">
enum <code class="descname">QemuClipboardType</code><a class="headerlink" href="#c.QemuClipboardType" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

Constants
<dl class="docutils">
<dt><code class="docutils literal notranslate">QEMU_CLIPBOARD_TYPE_TEXT</code></dt>
<dd>text/plain; charset=utf-8</dd>
<dt><code class="docutils literal notranslate">QEMU_CLIPBOARD_TYPE__COUNT</code></dt>
<dd>type count.</dd>
</dl>
<dl class="type">
<dt id="c.QemuClipboardSelection">
enum <code class="descname">QemuClipboardSelection</code><a class="headerlink" href="#c.QemuClipboardSelection" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

Constants
<dl class="docutils">
<dt><code class="docutils literal notranslate">QEMU_CLIPBOARD_SELECTION_CLIPBOARD</code></dt>
<dd>clipboard (explitcit cut+paste).</dd>
<dt><code class="docutils literal notranslate">QEMU_CLIPBOARD_SELECTION_PRIMARY</code></dt>
<dd>primary selection (select + middle mouse button).</dd>
<dt><code class="docutils literal notranslate">QEMU_CLIPBOARD_SELECTION_SECONDARY</code></dt>
<dd>secondary selection (dunno).</dd>
<dt><code class="docutils literal notranslate">QEMU_CLIPBOARD_SELECTION__COUNT</code></dt>
<dd>selection count.</dd>
</dl>
<dl class="type">
<dt id="c.QemuClipboardPeer">
struct <code class="descname">QemuClipboardPeer</code><a class="headerlink" href="#c.QemuClipboardPeer" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

Definition
<div class="highlight-default notranslate"><div class="highlight"><pre>struct QemuClipboardInfo {
 uint32_t refcount;
 QemuClipboardPeer *owner;
 QemuClipboardSelection selection;
 struct {
 bool available;
 bool requested;
 size_t size;
 void *data;
 } types[QEMU_CLIPBOARD_TYPE__COUNT];
};
</pre></div>
</div>
Members
<dl class="docutils">
<dt><code class="docutils literal notranslate">refcount</code></dt>
<dd>reference counter.</dd>
<dt><code class="docutils literal notranslate">owner</code></dt>
<dd>clipboard owner.</dd>
<dt><code class="docutils literal notranslate">selection</code></dt>
<dd>clipboard selection.</dd>
<dt><code class="docutils literal notranslate">types</code></dt>
<dd>clipboard data array (one entry per type).</dd>
</dl>
Description
Clipboard content data and metadata.
<dl class="function">
<dt id="c.qemu_clipboard_peer_register">
void <code class="descname">qemu_clipboard_peer_register</code>(<a class="reference internal" href="#c.QemuClipboardPeer" title="QemuClipboardPeer">QemuClipboardPeer</a>&nbsp;*peer)<a class="headerlink" href="#c.qemu_clipboard_peer_register" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

Parameters
<dl class="docutils">
<dt><code class="docutils literal notranslate">QemuClipboardPeer *peer</code></dt>
<dd>peer information.</dd>
</dl>
Description
Register clipboard peer. Registering is needed for both active
(set+grab clipboard) and passive (watch clipboard for updates)
interaction with the qemu clipboard.
<dl class="function">
<dt id="c.qemu_clipboard_peer_unregister">
void <code class="descname">qemu_clipboard_peer_unregister</code>(<a class="reference internal" href="#c.QemuClipboardPeer" title="QemuClipboardPeer">QemuClipboardPeer</a>&nbsp;*peer)<a class="headerlink" href="#c.qemu_clipboard_peer_unregister" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

Parameters
<dl class="docutils">
<dt><code class="docutils literal notranslate">QemuClipboardPeer *peer</code></dt>
<dd>peer information.</dd>
</dl>
Description
Unregister clipboard peer.
<dl class="function">
<dt id="c.qemu_clipboard_peer_owns">
bool <code class="descname">qemu_clipboard_peer_owns</code>(<a class="reference internal" href="#c.QemuClipboardPeer" title="QemuClipboardPeer">QemuClipboardPeer</a>&nbsp;*peer, <a class="reference internal" href="#c.QemuClipboardSelection" title="QemuClipboardSelection">QemuClipboardSelection</a>&nbsp;selection)<a class="headerlink" href="#c.qemu_clipboard_peer_owns" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

Parameters
<dl class="docutils">
<dt><code class="docutils literal notranslate">QemuClipboardPeer *peer</code></dt>
<dd>peer information.</dd>
<dt><code class="docutils literal notranslate">QemuClipboardSelection selection</code></dt>
<dd>clipboard selection.</dd>
</dl>
Description
Return TRUE if the peer owns the clipboard.
<dl class="function">
<dt id="c.qemu_clipboard_peer_release">
void <code class="descname">qemu_clipboard_peer_release</code>(<a class="reference internal" href="#c.QemuClipboardPeer" title="QemuClipboardPeer">QemuClipboardPeer</a>&nbsp;*peer, <a class="reference internal" href="#c.QemuClipboardSelection" title="QemuClipboardSelection">QemuClipboardSelection</a>&nbsp;selection)<a class="headerlink" href="#c.qemu_clipboard_peer_release" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

Parameters
<dl class="docutils">
<dt><code class="docutils literal notranslate">QemuClipboardPeer *peer</code></dt>
<dd>peer information.</dd>
<dt><code class="docutils literal notranslate">QemuClipboardSelection selection</code></dt>
<dd>clipboard selection.</dd>
</dl>
Description
If the peer owns the clipboard, release it.
<dl class="function">
<dt id="c.qemu_clipboard_info">
<a class="reference internal" href="#c.QemuClipboardInfo" title="QemuClipboardInfo">QemuClipboardInfo</a> * <code class="descname">qemu_clipboard_info</code>(<a class="reference internal" href="#c.QemuClipboardSelection" title="QemuClipboardSelection">QemuClipboardSelection</a>&nbsp;selection)<a class="headerlink" href="#c.qemu_clipboard_info" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

Parameters
<dl class="docutils">
<dt><code class="docutils literal notranslate">QemuClipboardSelection selection</code></dt>
<dd>clipboard selection.</dd>
</dl>
Description
Return the current clipboard data &amp; owner informations.
<dl class="function">
<dt id="c.qemu_clipboard_info_new">
<a class="reference internal" href="#c.QemuClipboardInfo" title="QemuClipboardInfo">QemuClipboardInfo</a> * <code class="descname">qemu_clipboard_info_new</code>(<a class="reference internal" href="#c.QemuClipboardPeer" title="QemuClipboardPeer">QemuClipboardPeer</a>&nbsp;*owner, <a class="reference internal" href="#c.QemuClipboardSelection" title="QemuClipboardSelection">QemuClipboardSelection</a>&nbsp;selection)<a class="headerlink" href="#c.qemu_clipboard_info_new" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

Parameters
<dl class="docutils">
<dt><code class="docutils literal notranslate">QemuClipboardPeer *owner</code></dt>
<dd>clipboard owner.</dd>
<dt><code class="docutils literal notranslate">QemuClipboardSelection selection</code></dt>
<dd>clipboard selection.</dd>
</dl>
Description
Allocate a new QemuClipboardInfo and initialize it with the given
owner and selection.
QemuClipboardInfo is a reference-counted struct. The new struct is
returned with a reference already taken (i.e. reference count is
one).
<dl class="function">
<dt id="c.qemu_clipboard_info_ref">
<a class="reference internal" href="#c.QemuClipboardInfo" title="QemuClipboardInfo">QemuClipboardInfo</a> * <code class="descname">qemu_clipboard_info_ref</code>(<a class="reference internal" href="#c.QemuClipboardInfo" title="QemuClipboardInfo">QemuClipboardInfo</a>&nbsp;*info)<a class="headerlink" href="#c.qemu_clipboard_info_ref" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

Parameters
<dl class="docutils">
<dt><code class="docutils literal notranslate">QemuClipboardInfo *info</code></dt>
<dd>clipboard info.</dd>
</dl>
Description
Increase info reference count.
<dl class="function">
<dt id="c.qemu_clipboard_info_unref">
void <code class="descname">qemu_clipboard_info_unref</code>(<a class="reference internal" href="#c.QemuClipboardInfo" title="QemuClipboardInfo">QemuClipboardInfo</a>&nbsp;*info)<a class="headerlink" href="#c.qemu_clipboard_info_unref" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

Parameters
<dl class="docutils">
<dt><code class="docutils literal notranslate">QemuClipboardInfo *info</code></dt>
<dd>clipboard info.</dd>
</dl>
Description
Decrease info reference count. When the count goes down to zero
free the info struct itself and all clipboard data.
<dl class="function">
<dt id="c.qemu_clipboard_update">
void <code class="descname">qemu_clipboard_update</code>(<a class="reference internal" href="#c.QemuClipboardInfo" title="QemuClipboardInfo">QemuClipboardInfo</a>&nbsp;*info)<a class="headerlink" href="#c.qemu_clipboard_update" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

Parameters
<dl class="docutils">
<dt><code class="docutils literal notranslate">QemuClipboardInfo *info</code></dt>
<dd>clipboard info.</dd>
</dl>
Description
Update the qemu clipboard. Notify all registered peers (including
the clipboard owner) that the qemu clipboard has been updated.
This is used for both new completely clipboard content and for
clipboard data updates in response to qemu_clipboard_request()
calls.
<dl class="function">
<dt id="c.qemu_clipboard_request">
void <code class="descname">qemu_clipboard_request</code>(<a class="reference internal" href="#c.QemuClipboardInfo" title="QemuClipboardInfo">QemuClipboardInfo</a>&nbsp;*info, <a class="reference internal" href="#c.QemuClipboardType" title="QemuClipboardType">QemuClipboardType</a>&nbsp;type)<a class="headerlink" href="#c.qemu_clipboard_request" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

Parameters
<dl class="docutils">
<dt><code class="docutils literal notranslate">QemuClipboardInfo *info</code></dt>
<dd>clipboard info.</dd>
<dt><code class="docutils literal notranslate">QemuClipboardType type</code></dt>
<dd>clipboard data type.</dd>
</dl>
Description
Request clipboard content. Typically the clipboard owner only
advertises the available data types and provides the actual data
only on request.
<dl class="function">
<dt id="c.qemu_clipboard_set_data">
void <code class="descname">qemu_clipboard_set_data</code>(<a class="reference internal" href="#c.QemuClipboardPeer" title="QemuClipboardPeer">QemuClipboardPeer</a>&nbsp;*peer, <a class="reference internal" href="#c.QemuClipboardInfo" title="QemuClipboardInfo">QemuClipboardInfo</a>&nbsp;*info, <a class="reference internal" href="#c.QemuClipboardType" title="QemuClipboardType">QemuClipboardType</a>&nbsp;type, uint32_t&nbsp;size, const void&nbsp;*data, bool&nbsp;update)<a class="headerlink" href="#c.qemu_clipboard_set_data" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

Parameters
<dl class="docutils">
<dt><code class="docutils literal notranslate">QemuClipboardPeer *peer</code></dt>
<dd>clipboard peer.</dd>
<dt><code class="docutils literal notranslate">QemuClipboardInfo *info</code></dt>
<dd>clipboard info.</dd>
<dt><code class="docutils literal notranslate">QemuClipboardType type</code></dt>
<dd>clipboard data type.</dd>
<dt><code class="docutils literal notranslate">uint32_t size</code></dt>
<dd>data size.</dd>
<dt><code class="docutils literal notranslate">const void *data</code></dt>
<dd>data blob.</dd>
<dt><code class="docutils literal notranslate">bool update</code></dt>
<dd>notify peers about the update.</dd>
</dl>
Description
Set clipboard content for the given type. This function will make
a copy of the content data and store that.
</div>
</div>

</div>
 
 </div>
 <footer>
 
 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
 <a href="reset.html" class="btn btn-neutral float-right" title="Reset in QEMU: the Resettable interface" accesskey="n" rel="next">Next </a>
 
 
 <a href="bitops.html" class="btn btn-neutral" title="Bitwise operations" accesskey="p" rel="prev"> Previous</a>
 
 </div>

<hr/>

</div>
 Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

This documentation is for QEMU version 6.2.0.

<a href="../about/license.html">QEMU and this manual are released under the
GNU General Public License, version 2.</a>

</footer>

</div>
 </div>

</section>

</div>

</body>
</html>