<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="GdkSeat">
<refmeta>
<refentrytitle role="top_of_page" id="GdkSeat.top_of_page">GdkSeat</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GDK4 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GdkSeat</refname>
<refpurpose>Object representing an user seat</refpurpose>
</refnamediv>

<refsect1 id="GdkSeat.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_return" colwidth="150px"/>
<colspec colname="functions_name"/>
<tbody>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><phrase role="c_punctuation">(</phrase><link linkend="GdkSeatGrabPrepareFunc">*GdkSeatGrabPrepareFunc</link><phrase role="c_punctuation">)</phrase>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GdkDisplay"><returnvalue>GdkDisplay</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gdk-seat-get-display">gdk_seat_get_display</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GdkGrabStatus"><returnvalue>GdkGrabStatus</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-seat-grab">gdk_seat_grab</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-seat-ungrab">gdk_seat_ungrab</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GdkSeatCapabilities"><returnvalue>GdkSeatCapabilities</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-seat-get-capabilities">gdk_seat_get_capabilities</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GdkDevice"><returnvalue>GdkDevice</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gdk-seat-get-pointer">gdk_seat_get_pointer</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GdkDevice"><returnvalue>GdkDevice</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gdk-seat-get-keyboard">gdk_seat_get_keyboard</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GList"><returnvalue>GList</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gdk-seat-get-slaves">gdk_seat_get_slaves</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GList"><returnvalue>GList</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gdk-seat-get-master-pointers">gdk_seat_get_master_pointers</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GdkSeat.properties" role="properties">
<title role="properties.title">Properties</title>
<informaltable frame="none">
<tgroup cols="3">
<colspec colname="properties_type" colwidth="150px"/>
<colspec colname="properties_name" colwidth="300px"/>
<colspec colname="properties_flags" colwidth="200px"/>
<tbody>
<row><entry role="property_type"><link linkend="GdkDisplay"><type>GdkDisplay</type></link>&#160;*</entry><entry role="property_name"><link linkend="GdkSeat--display">display</link></entry><entry role="property_flags">Read / Write / Construct Only</entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GdkSeat.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<informaltable frame="none">
<tgroup cols="3">
<colspec colname="signals_return" colwidth="150px"/>
<colspec colname="signals_name" colwidth="300px"/>
<colspec colname="signals_flags" colwidth="200px"/>
<tbody>
<row><entry role="signal_type"><link linkend="void"><returnvalue>void</returnvalue></link></entry><entry role="signal_name"><link linkend="GdkSeat-device-added">device-added</link></entry><entry role="signal_flags"><link linkend="G-SIGNAL-RUN-LAST:CAPS">Run Last</link></entry></row>
<row><entry role="signal_type"><link linkend="void"><returnvalue>void</returnvalue></link></entry><entry role="signal_name"><link linkend="GdkSeat-device-removed">device-removed</link></entry><entry role="signal_flags"><link linkend="G-SIGNAL-RUN-LAST:CAPS">Run Last</link></entry></row>
<row><entry role="signal_type"><link linkend="void"><returnvalue>void</returnvalue></link></entry><entry role="signal_name"><link linkend="GdkSeat-tool-added">tool-added</link></entry><entry role="signal_flags"><link linkend="G-SIGNAL-RUN-LAST:CAPS">Run Last</link></entry></row>
<row><entry role="signal_type"><link linkend="void"><returnvalue>void</returnvalue></link></entry><entry role="signal_name"><link linkend="GdkSeat-tool-removed">tool-removed</link></entry><entry role="signal_flags"><link linkend="G-SIGNAL-RUN-LAST:CAPS">Run Last</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GdkSeat.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="name" colwidth="150px"/>
<colspec colname="description"/>
<tbody>
<row><entry role="datatype_keyword"></entry><entry role="function_name"><link linkend="GdkSeat-struct">GdkSeat</link></entry></row>
<row><entry role="datatype_keyword">enum</entry><entry role="function_name"><link linkend="GdkSeatCapabilities">GdkSeatCapabilities</link></entry></row>
<row><entry role="datatype_keyword">enum</entry><entry role="function_name"><link linkend="GdkGrabStatus">GdkGrabStatus</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GdkSeat.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen>    <link linkend="GObject">GObject</link>
    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> GdkSeat
</screen>
</refsect1>

<refsect1 id="GdkSeat.includes"><title>Includes</title><synopsis>#include &lt;gdk/gdk.h&gt;
</synopsis></refsect1>

<refsect1 id="GdkSeat.description" role="desc">
<title role="desc.title">Description</title>
<para>The <link linkend="GdkSeat"><type>GdkSeat</type></link> object represents a collection of input devices
that belong to a user.</para>

</refsect1>
<refsect1 id="GdkSeat.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="GdkSeatGrabPrepareFunc" role="function">
<title>GdkSeatGrabPrepareFunc&#160;()</title>
<indexterm zone="GdkSeatGrabPrepareFunc"><primary>GdkSeatGrabPrepareFunc</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
<phrase role="c_punctuation">(</phrase>*GdkSeatGrabPrepareFunc<phrase role="c_punctuation">)</phrase> (<parameter><link linkend="GdkSeat"><type>GdkSeat</type></link> *seat</parameter>,
                           <parameter><link linkend="GdkSurface"><type>GdkSurface</type></link> *surface</parameter>,
                           <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>);</programlisting>
<para>Type of the callback used to set up <parameter>surface</parameter>
 so it can be
grabbed. A typical action would be ensuring the surface is
visible, although there's room for other initialization
actions.</para>
<refsect3 id="GdkSeatGrabPrepareFunc.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>seat</para></entry>
<entry role="parameter_description"><para>the <link linkend="GdkSeat"><type>GdkSeat</type></link> being grabbed</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>surface</para></entry>
<entry role="parameter_description"><para>the <link linkend="GdkSurface"><type>GdkSurface</type></link> being grabbed</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>user_data</para></entry>
<entry role="parameter_description"><para>user data passed in <link linkend="gdk-seat-grab"><function>gdk_seat_grab()</function></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gdk-seat-get-display" role="function">
<title>gdk_seat_get_display&#160;()</title>
<indexterm zone="gdk-seat-get-display"><primary>gdk_seat_get_display</primary></indexterm>
<programlisting language="C"><link linkend="GdkDisplay"><returnvalue>GdkDisplay</returnvalue></link>&#160;*
gdk_seat_get_display (<parameter><link linkend="GdkSeat"><type>GdkSeat</type></link> *seat</parameter>);</programlisting>
<para>Returns the <link linkend="GdkDisplay"><type>GdkDisplay</type></link> this seat belongs to.</para>
<refsect3 id="gdk-seat-get-display.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>seat</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkSeat"><type>GdkSeat</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-seat-get-display.returns" role="returns">
<title>Returns</title>
<para>a <link linkend="GdkDisplay"><type>GdkDisplay</type></link>. This object is owned by GTK+
and must not be freed. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gdk-seat-grab" role="function">
<title>gdk_seat_grab&#160;()</title>
<indexterm zone="gdk-seat-grab"><primary>gdk_seat_grab</primary></indexterm>
<programlisting language="C"><link linkend="GdkGrabStatus"><returnvalue>GdkGrabStatus</returnvalue></link>
gdk_seat_grab (<parameter><link linkend="GdkSeat"><type>GdkSeat</type></link> *seat</parameter>,
               <parameter><link linkend="GdkSurface"><type>GdkSurface</type></link> *surface</parameter>,
               <parameter><link linkend="GdkSeatCapabilities"><type>GdkSeatCapabilities</type></link> capabilities</parameter>,
               <parameter><link linkend="gboolean"><type>gboolean</type></link> owner_events</parameter>,
               <parameter><link linkend="GdkCursor"><type>GdkCursor</type></link> *cursor</parameter>,
               <parameter>const <link linkend="GdkEvent"><type>GdkEvent</type></link> *event</parameter>,
               <parameter><link linkend="GdkSeatGrabPrepareFunc"><type>GdkSeatGrabPrepareFunc</type></link> prepare_func</parameter>,
               <parameter><link linkend="gpointer"><type>gpointer</type></link> prepare_func_data</parameter>);</programlisting>
<para>Grabs the seat so that all events corresponding to the given <parameter>capabilities</parameter>

are passed to this application until the seat is ungrabbed with <link linkend="gdk-seat-ungrab"><function>gdk_seat_ungrab()</function></link>,
or the surface becomes hidden. This overrides any previous grab on the
seat by this client.</para>
<para>As a rule of thumb, if a grab is desired over <link linkend="GDK-SEAT-CAPABILITY-POINTER:CAPS"><literal>GDK_SEAT_CAPABILITY_POINTER</literal></link>,
all other "pointing" capabilities (eg. <link linkend="GDK-SEAT-CAPABILITY-TOUCH:CAPS"><literal>GDK_SEAT_CAPABILITY_TOUCH</literal></link>) should
be grabbed too, so the user is able to interact with all of those while
the grab holds, you should thus use <link linkend="GDK-SEAT-CAPABILITY-ALL-POINTING:CAPS"><literal>GDK_SEAT_CAPABILITY_ALL_POINTING</literal></link> most
commonly.</para>
<para>Grabs are used for operations which need complete control over the
events corresponding to the given capabilities. For example in GTK+ this
is used for Drag and Drop operations, popup menus and such.</para>
<para>Note that if the event mask of a <link linkend="GdkSurface"><type>GdkSurface</type></link> has selected both button press
and button release events, or touch begin and touch end, then a press event
will cause an automatic grab until the button is released, equivalent to a
grab on the surface with <parameter>owner_events</parameter>
 set to <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>. This is done because most
applications expect to receive paired press and release events.</para>
<para>If you set up anything at the time you take the grab that needs to be
cleaned up when the grab ends, you should handle the <link linkend="GdkEventGrabBroken"><type>GdkEventGrabBroken</type></link>
events that are emitted when the grab ends unvoluntarily.</para>
<refsect3 id="gdk-seat-grab.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>seat</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkSeat"><type>GdkSeat</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>surface</para></entry>
<entry role="parameter_description"><para>the <link linkend="GdkSurface"><type>GdkSurface</type></link> which will own the grab</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>capabilities</para></entry>
<entry role="parameter_description"><para>capabilities that will be grabbed</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>owner_events</para></entry>
<entry role="parameter_description"><para>if <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> then all device events are reported with respect to
<parameter>surface</parameter>
and are only reported if selected by <parameter>event_mask</parameter>
. If
<link linkend="TRUE:CAPS"><literal>TRUE</literal></link> then pointer events for this application are reported
as normal, but pointer events outside this application are
reported with respect to <parameter>surface</parameter>
and only if selected by
<parameter>event_mask</parameter>
. In either mode, unreported events are discarded.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>cursor</para></entry>
<entry role="parameter_description"><para>the cursor to display while the grab is active. If
this is <link linkend="NULL:CAPS"><literal>NULL</literal></link> then the normal cursors are used for
<parameter>surface</parameter>
and its descendants, and the cursor for <parameter>surface</parameter>
is used
elsewhere. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>nullable</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>event</para></entry>
<entry role="parameter_description"><para>the event that is triggering the grab, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if none
is available. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>nullable</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>prepare_func</para></entry>
<entry role="parameter_description"><para>function to
prepare the surface to be grabbed, it can be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>surface</parameter>
is
visible before this call. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>nullable</acronym>][<acronym>scope call</acronym>][<acronym>closure</acronym> prepare_func_data]</emphasis></entry></row>
<row><entry role="parameter_name"><para>prepare_func_data</para></entry>
<entry role="parameter_description"><para>user data to pass to <parameter>prepare_func</parameter>
</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-seat-grab.returns" role="returns">
<title>Returns</title>
<para> <link linkend="GDK-GRAB-SUCCESS:CAPS"><literal>GDK_GRAB_SUCCESS</literal></link> if the grab was successful.</para>
</refsect3></refsect2>
<refsect2 id="gdk-seat-ungrab" role="function">
<title>gdk_seat_ungrab&#160;()</title>
<indexterm zone="gdk-seat-ungrab"><primary>gdk_seat_ungrab</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gdk_seat_ungrab (<parameter><link linkend="GdkSeat"><type>GdkSeat</type></link> *seat</parameter>);</programlisting>
<para>Releases a grab added through <link linkend="gdk-seat-grab"><function>gdk_seat_grab()</function></link>.</para>
<refsect3 id="gdk-seat-ungrab.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>seat</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkSeat"><type>GdkSeat</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gdk-seat-get-capabilities" role="function">
<title>gdk_seat_get_capabilities&#160;()</title>
<indexterm zone="gdk-seat-get-capabilities"><primary>gdk_seat_get_capabilities</primary></indexterm>
<programlisting language="C"><link linkend="GdkSeatCapabilities"><returnvalue>GdkSeatCapabilities</returnvalue></link>
gdk_seat_get_capabilities (<parameter><link linkend="GdkSeat"><type>GdkSeat</type></link> *seat</parameter>);</programlisting>
<para>Returns the capabilities this <link linkend="GdkSeat"><type>GdkSeat</type></link> currently has.</para>
<refsect3 id="gdk-seat-get-capabilities.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>seat</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkSeat"><type>GdkSeat</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-seat-get-capabilities.returns" role="returns">
<title>Returns</title>
<para> the seat capabilities</para>
</refsect3></refsect2>
<refsect2 id="gdk-seat-get-pointer" role="function">
<title>gdk_seat_get_pointer&#160;()</title>
<indexterm zone="gdk-seat-get-pointer"><primary>gdk_seat_get_pointer</primary></indexterm>
<programlisting language="C"><link linkend="GdkDevice"><returnvalue>GdkDevice</returnvalue></link>&#160;*
gdk_seat_get_pointer (<parameter><link linkend="GdkSeat"><type>GdkSeat</type></link> *seat</parameter>);</programlisting>
<para>Returns the master device that routes pointer events.</para>
<refsect3 id="gdk-seat-get-pointer.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>seat</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkSeat"><type>GdkSeat</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-seat-get-pointer.returns" role="returns">
<title>Returns</title>
<para>a master <link linkend="GdkDevice"><type>GdkDevice</type></link> with pointer
capabilities. This object is owned by GTK+ and must not be freed. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>][<acronym>nullable</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gdk-seat-get-keyboard" role="function">
<title>gdk_seat_get_keyboard&#160;()</title>
<indexterm zone="gdk-seat-get-keyboard"><primary>gdk_seat_get_keyboard</primary></indexterm>
<programlisting language="C"><link linkend="GdkDevice"><returnvalue>GdkDevice</returnvalue></link>&#160;*
gdk_seat_get_keyboard (<parameter><link linkend="GdkSeat"><type>GdkSeat</type></link> *seat</parameter>);</programlisting>
<para>Returns the master device that routes keyboard events.</para>
<refsect3 id="gdk-seat-get-keyboard.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>seat</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkSeat"><type>GdkSeat</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-seat-get-keyboard.returns" role="returns">
<title>Returns</title>
<para>a master <link linkend="GdkDevice"><type>GdkDevice</type></link> with keyboard
capabilities. This object is owned by GTK+ and must not be freed. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>][<acronym>nullable</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gdk-seat-get-slaves" role="function">
<title>gdk_seat_get_slaves&#160;()</title>
<indexterm zone="gdk-seat-get-slaves"><primary>gdk_seat_get_slaves</primary></indexterm>
<programlisting language="C"><link linkend="GList"><returnvalue>GList</returnvalue></link>&#160;*
gdk_seat_get_slaves (<parameter><link linkend="GdkSeat"><type>GdkSeat</type></link> *seat</parameter>,
                     <parameter><link linkend="GdkSeatCapabilities"><type>GdkSeatCapabilities</type></link> capabilities</parameter>);</programlisting>
<para>Returns the slave devices that match the given capabilities.</para>
<refsect3 id="gdk-seat-get-slaves.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>seat</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkSeat"><type>GdkSeat</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>capabilities</para></entry>
<entry role="parameter_description"><para>capabilities to get devices for</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-seat-get-slaves.returns" role="returns">
<title>Returns</title>
<para>A list of <link linkend="GdkDevices"><type>GdkDevices</type></link>.
The list must be freed with <link linkend="g-list-free"><function>g_list_free()</function></link>, the elements are owned
by GDK and must not be freed. </para>
<para><emphasis role="annotation">[<acronym>transfer container</acronym>][<acronym>element-type</acronym> GdkDevice]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gdk-seat-get-master-pointers" role="function">
<title>gdk_seat_get_master_pointers&#160;()</title>
<indexterm zone="gdk-seat-get-master-pointers"><primary>gdk_seat_get_master_pointers</primary></indexterm>
<programlisting language="C"><link linkend="GList"><returnvalue>GList</returnvalue></link>&#160;*
gdk_seat_get_master_pointers (<parameter><link linkend="GdkSeat"><type>GdkSeat</type></link> *seat</parameter>,
                              <parameter><link linkend="GdkSeatCapabilities"><type>GdkSeatCapabilities</type></link> capabilities</parameter>);</programlisting>
<para>Returns all master pointers with the given capabilities driven by this <parameter>seat</parameter>
.
On most backends this function will return a list with a single element (meaning
that all input devices drive the same onscreen cursor).</para>
<para>In other backends where there can possibly be multiple foci (eg. wayland),
this function will return all master <link linkend="GdkDevices"><type>GdkDevices</type></link> that represent these.</para>
<refsect3 id="gdk-seat-get-master-pointers.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>seat</para></entry>
<entry role="parameter_description"><para>The <link linkend="GdkSeat"><type>GdkSeat</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>capabilities</para></entry>
<entry role="parameter_description"><para>Queried capabilities</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-seat-get-master-pointers.returns" role="returns">
<title>Returns</title>
<para>A list
of master pointing devices. </para>
<para><emphasis role="annotation">[<acronym>transfer container</acronym>][<acronym>element-type</acronym> GdkDevice]</emphasis></para>
</refsect3></refsect2>

</refsect1>
<refsect1 id="GdkSeat.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="GdkSeat-struct" role="struct">
<title>GdkSeat</title>
<indexterm zone="GdkSeat-struct"><primary>GdkSeat</primary></indexterm>
<programlisting language="C">typedef struct _GdkSeat GdkSeat;</programlisting>
<para>The GdkSeat struct contains only private fields and
should not be accessed directly.</para>
</refsect2>
<refsect2 id="GdkSeatCapabilities" role="enum">
<title>enum GdkSeatCapabilities</title>
<indexterm zone="GdkSeatCapabilities"><primary>GdkSeatCapabilities</primary></indexterm>
<para>Flags describing the seat capabilities.</para>
<refsect3 id="GdkSeatCapabilities.members" role="enum_members">
<title>Members</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="enum_members_name" colwidth="300px"/>
<colspec colname="enum_members_description"/>
<colspec colname="enum_members_annotations" colwidth="200px"/>
<tbody>
<row role="constant"><entry role="enum_member_name"><para id="GDK-SEAT-CAPABILITY-NONE:CAPS">GDK_SEAT_CAPABILITY_NONE</para></entry>
<entry role="enum_member_description"><para>No input capabilities</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="GDK-SEAT-CAPABILITY-POINTER:CAPS">GDK_SEAT_CAPABILITY_POINTER</para></entry>
<entry role="enum_member_description"><para>The seat has a pointer (e.g. mouse)</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="GDK-SEAT-CAPABILITY-TOUCH:CAPS">GDK_SEAT_CAPABILITY_TOUCH</para></entry>
<entry role="enum_member_description"><para>The seat has touchscreen(s) attached</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="GDK-SEAT-CAPABILITY-TABLET-STYLUS:CAPS">GDK_SEAT_CAPABILITY_TABLET_STYLUS</para></entry>
<entry role="enum_member_description"><para>The seat has drawing tablet(s) attached</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="GDK-SEAT-CAPABILITY-KEYBOARD:CAPS">GDK_SEAT_CAPABILITY_KEYBOARD</para></entry>
<entry role="enum_member_description"><para>The seat has keyboard(s) attached</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="GDK-SEAT-CAPABILITY-TABLET-PAD:CAPS">GDK_SEAT_CAPABILITY_TABLET_PAD</para></entry>
<entry role="enum_member_description"><para>The seat has drawing tablet pad(s) attached</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="GDK-SEAT-CAPABILITY-ALL-POINTING:CAPS">GDK_SEAT_CAPABILITY_ALL_POINTING</para></entry>
<entry role="enum_member_description"><para>The union of all pointing capabilities</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="GDK-SEAT-CAPABILITY-ALL:CAPS">GDK_SEAT_CAPABILITY_ALL</para></entry>
<entry role="enum_member_description"><para>The union of all capabilities</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="GdkGrabStatus" role="enum">
<title>enum GdkGrabStatus</title>
<indexterm zone="GdkGrabStatus"><primary>GdkGrabStatus</primary></indexterm>
<para>Returned by <link linkend="gdk-device-grab"><function>gdk_device_grab()</function></link> to indicate success or the reason for the
failure of the grab attempt.</para>
<refsect3 id="GdkGrabStatus.members" role="enum_members">
<title>Members</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="enum_members_name" colwidth="300px"/>
<colspec colname="enum_members_description"/>
<colspec colname="enum_members_annotations" colwidth="200px"/>
<tbody>
<row role="constant"><entry role="enum_member_name"><para id="GDK-GRAB-SUCCESS:CAPS">GDK_GRAB_SUCCESS</para></entry>
<entry role="enum_member_description"><para>the resource was successfully grabbed.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="GDK-GRAB-ALREADY-GRABBED:CAPS">GDK_GRAB_ALREADY_GRABBED</para></entry>
<entry role="enum_member_description"><para>the resource is actively grabbed by another client.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="GDK-GRAB-INVALID-TIME:CAPS">GDK_GRAB_INVALID_TIME</para></entry>
<entry role="enum_member_description"><para>the resource was grabbed more recently than the
 specified time.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="GDK-GRAB-NOT-VIEWABLE:CAPS">GDK_GRAB_NOT_VIEWABLE</para></entry>
<entry role="enum_member_description"><para>the grab surface or the <parameter>confine_to</parameter>
 surface are not
 viewable.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="GDK-GRAB-FROZEN:CAPS">GDK_GRAB_FROZEN</para></entry>
<entry role="enum_member_description"><para>the resource is frozen by an active grab of another client.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="GDK-GRAB-FAILED:CAPS">GDK_GRAB_FAILED</para></entry>
<entry role="enum_member_description"><para>the grab failed for some other reason</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>

</refsect1>
<refsect1 id="GdkSeat.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GdkSeat--display" role="property"><title>The <literal>“display”</literal> property</title>
<indexterm zone="GdkSeat--display"><primary>GdkSeat:display</primary></indexterm>
<programlisting>  “display”                  <link linkend="GdkDisplay"><type>GdkDisplay</type></link>&#160;*</programlisting>
<para><link linkend="GdkDisplay"><type>GdkDisplay</type></link> of this seat.</para>
<para>Flags: Read / Write / Construct Only</para>
</refsect2>

</refsect1>
<refsect1 id="GdkSeat.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="GdkSeat-device-added" role="signal"><title>The <literal>“device-added”</literal> signal</title>
<indexterm zone="GdkSeat-device-added"><primary>GdkSeat::device-added</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
user_function (<link linkend="GdkSeat"><type>GdkSeat</type></link>   *seat,
               <link linkend="GdkDevice"><type>GdkDevice</type></link> *device,
               <link linkend="gpointer"><type>gpointer</type></link>   user_data)</programlisting>
<para>The ::device-added signal is emitted when a new input
device is related to this seat.</para>
<refsect3 id="GdkSeat-device-added.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>seat</para></entry>
<entry role="parameter_description"><para>the object on which the signal is emitted</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>device</para></entry>
<entry role="parameter_description"><para>the newly added <link linkend="GdkDevice"><type>GdkDevice</type></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><simpara>user_data</simpara></entry>
<entry role="parameter_description"><simpara>user data set when the signal handler was connected.</simpara></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para>Flags: <link linkend="G-SIGNAL-RUN-LAST:CAPS">Run Last</link></para>
</refsect2><refsect2 id="GdkSeat-device-removed" role="signal"><title>The <literal>“device-removed”</literal> signal</title>
<indexterm zone="GdkSeat-device-removed"><primary>GdkSeat::device-removed</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
user_function (<link linkend="GdkSeat"><type>GdkSeat</type></link>   *seat,
               <link linkend="GdkDevice"><type>GdkDevice</type></link> *device,
               <link linkend="gpointer"><type>gpointer</type></link>   user_data)</programlisting>
<para>The ::device-removed signal is emitted when an
input device is removed (e.g. unplugged).</para>
<refsect3 id="GdkSeat-device-removed.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>seat</para></entry>
<entry role="parameter_description"><para>the object on which the signal is emitted</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>device</para></entry>
<entry role="parameter_description"><para>the just removed <link linkend="GdkDevice"><type>GdkDevice</type></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><simpara>user_data</simpara></entry>
<entry role="parameter_description"><simpara>user data set when the signal handler was connected.</simpara></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para>Flags: <link linkend="G-SIGNAL-RUN-LAST:CAPS">Run Last</link></para>
</refsect2><refsect2 id="GdkSeat-tool-added" role="signal"><title>The <literal>“tool-added”</literal> signal</title>
<indexterm zone="GdkSeat-tool-added"><primary>GdkSeat::tool-added</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
user_function (<link linkend="GdkSeat"><type>GdkSeat</type></link>       *seat,
               <link linkend="GdkDeviceTool"><type>GdkDeviceTool</type></link> *tool,
               <link linkend="gpointer"><type>gpointer</type></link>       user_data)</programlisting>
<para>The ::tool-added signal is emitted whenever a new tool
is made known to the seat. The tool may later be assigned
to a device (i.e. on proximity with a tablet). The device
will emit the <link linkend="GdkDevice-tool-changed"><type>“tool-changed”</type></link> signal accordingly.</para>
<para>A same tool may be used by several devices.</para>
<refsect3 id="GdkSeat-tool-added.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>seat</para></entry>
<entry role="parameter_description"><para>the object on which the signal is emitted</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>tool</para></entry>
<entry role="parameter_description"><para>the new <link linkend="GdkDeviceTool"><type>GdkDeviceTool</type></link> known to the seat</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><simpara>user_data</simpara></entry>
<entry role="parameter_description"><simpara>user data set when the signal handler was connected.</simpara></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para>Flags: <link linkend="G-SIGNAL-RUN-LAST:CAPS">Run Last</link></para>
</refsect2><refsect2 id="GdkSeat-tool-removed" role="signal"><title>The <literal>“tool-removed”</literal> signal</title>
<indexterm zone="GdkSeat-tool-removed"><primary>GdkSeat::tool-removed</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
user_function (<link linkend="GdkSeat"><type>GdkSeat</type></link>       *seat,
               <link linkend="GdkDeviceTool"><type>GdkDeviceTool</type></link> *tool,
               <link linkend="gpointer"><type>gpointer</type></link>       user_data)</programlisting>
<para>This signal is emitted whenever a tool is no longer known
to this <parameter>seat</parameter>
.</para>
<refsect3 id="GdkSeat-tool-removed.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>seat</para></entry>
<entry role="parameter_description"><para>the object on which the signal is emitted</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>tool</para></entry>
<entry role="parameter_description"><para>the just removed <link linkend="GdkDeviceTool"><type>GdkDeviceTool</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><simpara>user_data</simpara></entry>
<entry role="parameter_description"><simpara>user data set when the signal handler was connected.</simpara></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para>Flags: <link linkend="G-SIGNAL-RUN-LAST:CAPS">Run Last</link></para>
</refsect2>
</refsect1>
<refsect1 id="GdkSeat.see-also">
<title>See Also</title>
<para><link linkend="GdkDisplay"><type>GdkDisplay</type></link>, <link linkend="GdkDevice"><type>GdkDevice</type></link></para>

</refsect1>

</refentry>
