<?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">
<!ENTITY pi "&#960;">
<!ENTITY solidus "&#8260;">
]>
<refentry id="GtkEventControllerMotion">
<refmeta>
<refentrytitle role="top_of_page" id="GtkEventControllerMotion.top_of_page">GtkEventControllerMotion</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK4 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkEventControllerMotion</refname>
<refpurpose>Event controller for motion events</refpurpose>
</refnamediv>

<refsect1 id="GtkEventControllerMotion.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_proto_type" colwidth="150px"/>
<colspec colname="functions_proto_name"/>
<tbody>
<row><entry role="function_type"><link linkend="GtkEventController"><returnvalue>GtkEventController</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-event-controller-motion-new">gtk_event_controller_motion_new</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-event-controller-motion-contains-pointer">gtk_event_controller_motion_contains_pointer</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-event-controller-motion-is-pointer">gtk_event_controller_motion_is_pointer</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkEventControllerMotion.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="gboolean"><type>gboolean</type></link></entry><entry role="property_name"><link linkend="GtkEventControllerMotion--contains-pointer">contains-pointer</link></entry><entry role="property_flags">Read</entry></row>
<row><entry role="property_type"><link linkend="gboolean"><type>gboolean</type></link></entry><entry role="property_name"><link linkend="GtkEventControllerMotion--is-pointer">is-pointer</link></entry><entry role="property_flags">Read</entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkEventControllerMotion.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<informaltable frame="none">
<tgroup cols="3">
<colspec colname="signal_proto_type" colwidth="150px"/>
<colspec colname="signal_proto_name" colwidth="300px"/>
<colspec colname="signal_proto_flags" colwidth="200px"/>
<tbody>
<row><entry role="signal_type"><link linkend="void"><returnvalue>void</returnvalue></link></entry><entry role="signal_name"><link linkend="GtkEventControllerMotion-enter">enter</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="GtkEventControllerMotion-leave">leave</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="GtkEventControllerMotion-motion">motion</link></entry><entry role="signal_flags"><link linkend="G-SIGNAL-RUN-FIRST:CAPS">Run First</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkEventControllerMotion.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="other_proto_type" colwidth="150px"/>
<colspec colname="other_proto_name"/>
<tbody>
<row><entry role="datatype_keyword"></entry><entry role="function_name"><link linkend="GtkEventControllerMotion-struct">GtkEventControllerMotion</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkEventControllerMotion.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> <link linkend="GtkEventController">GtkEventController</link>
        <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> GtkEventControllerMotion
</screen>
</refsect1>

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

<refsect1 id="GtkEventControllerMotion.description" role="desc">
<title role="desc.title">Description</title>
<para><link linkend="GtkEventControllerMotion"><type>GtkEventControllerMotion</type></link> is an event controller meant for situations
where you need to track the position of the pointer.</para>

</refsect1>
<refsect1 id="GtkEventControllerMotion.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="gtk-event-controller-motion-new" role="function">
<title>gtk_event_controller_motion_new&#160;()</title>
<indexterm zone="gtk-event-controller-motion-new"><primary>gtk_event_controller_motion_new</primary></indexterm>
<programlisting language="C"><link linkend="GtkEventController"><returnvalue>GtkEventController</returnvalue></link>&#160;*
gtk_event_controller_motion_new (<parameter><type>void</type></parameter>);</programlisting>
<para>Creates a new event controller that will handle motion events.</para>
<refsect3 id="gtk-event-controller-motion-new.returns" role="returns">
<title>Returns</title>
<para> a new <link linkend="GtkEventControllerMotion"><type>GtkEventControllerMotion</type></link></para>
</refsect3></refsect2>
<refsect2 id="gtk-event-controller-motion-contains-pointer" role="function">
<title>gtk_event_controller_motion_contains_pointer&#160;()</title>
<indexterm zone="gtk-event-controller-motion-contains-pointer"><primary>gtk_event_controller_motion_contains_pointer</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_event_controller_motion_contains_pointer
                               (<parameter><link linkend="GtkEventControllerMotion"><type>GtkEventControllerMotion</type></link> *self</parameter>);</programlisting>
<para>Returns the value of the GtkEventControllerMotion:contains-pointer property.</para>
<refsect3 id="gtk-event-controller-motion-contains-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>self</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkEventControllerMotion"><type>GtkEventControllerMotion</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-event-controller-motion-contains-pointer.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if a pointer is within <parameter>self</parameter>
or one of its children</para>
</refsect3></refsect2>
<refsect2 id="gtk-event-controller-motion-is-pointer" role="function">
<title>gtk_event_controller_motion_is_pointer&#160;()</title>
<indexterm zone="gtk-event-controller-motion-is-pointer"><primary>gtk_event_controller_motion_is_pointer</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_event_controller_motion_is_pointer
                               (<parameter><link linkend="GtkEventControllerMotion"><type>GtkEventControllerMotion</type></link> *self</parameter>);</programlisting>
<para>Returns the value of the GtkEventControllerMotion:is-pointer property.</para>
<refsect3 id="gtk-event-controller-motion-is-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>self</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkEventControllerMotion"><type>GtkEventControllerMotion</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-event-controller-motion-is-pointer.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if a pointer is within <parameter>self</parameter>
but not one of its children</para>
</refsect3></refsect2>

</refsect1>
<refsect1 id="GtkEventControllerMotion.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="GtkEventControllerMotion-struct" role="struct">
<title>GtkEventControllerMotion</title>
<indexterm zone="GtkEventControllerMotion-struct"><primary>GtkEventControllerMotion</primary></indexterm>
<programlisting language="C">typedef struct _GtkEventControllerMotion GtkEventControllerMotion;</programlisting>
</refsect2>

</refsect1>
<refsect1 id="GtkEventControllerMotion.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GtkEventControllerMotion--contains-pointer" role="property"><title>The <literal>“contains-pointer”</literal> property</title>
<indexterm zone="GtkEventControllerMotion--contains-pointer"><primary>GtkEventControllerMotion:contains-pointer</primary></indexterm>
<programlisting>  “contains-pointer”         <link linkend="gboolean"><type>gboolean</type></link></programlisting>
<para>Whether the pointer is in the controllers widget or a descendant.
See also <link linkend="GtkEventControllerMotion--is-pointer"><type>“is-pointer”</type></link>.</para>
<para>When handling crossing events, this property is updated
before <link linkend="GtkEventControllerMotion-enter"><type>“enter”</type></link> but after
<link linkend="GtkEventControllerMotion-leave"><type>“leave”</type></link> is emitted.</para>
<para>Owner: GtkEventControllerMotion</para>
<para>Flags: Read</para>
<para>Default value: FALSE</para>
</refsect2>
<refsect2 id="GtkEventControllerMotion--is-pointer" role="property"><title>The <literal>“is-pointer”</literal> property</title>
<indexterm zone="GtkEventControllerMotion--is-pointer"><primary>GtkEventControllerMotion:is-pointer</primary></indexterm>
<programlisting>  “is-pointer”               <link linkend="gboolean"><type>gboolean</type></link></programlisting>
<para>Whether the pointer is in the controllers widget itself,
as opposed to in a descendent widget. See also
<link linkend="GtkEventControllerMotion--contains-pointer"><type>“contains-pointer”</type></link>.</para>
<para>When handling crossing events, this property is updated
before <link linkend="GtkEventControllerMotion-enter"><type>“enter”</type></link> but after
<link linkend="GtkEventControllerMotion-leave"><type>“leave”</type></link> is emitted.</para>
<para>Owner: GtkEventControllerMotion</para>
<para>Flags: Read</para>
<para>Default value: FALSE</para>
</refsect2>

</refsect1>
<refsect1 id="GtkEventControllerMotion.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="GtkEventControllerMotion-enter" role="signal"><title>The <literal>“enter”</literal> signal</title>
<indexterm zone="GtkEventControllerMotion-enter"><primary>GtkEventControllerMotion::enter</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
user_function (<link linkend="GtkEventControllerMotion"><type>GtkEventControllerMotion</type></link> *controller,
               <link linkend="gdouble"><type>gdouble</type></link>                   x,
               <link linkend="gdouble"><type>gdouble</type></link>                   y,
               <link linkend="GdkCrossingMode"><type>GdkCrossingMode</type></link>           mode,
               <link linkend="gpointer"><type>gpointer</type></link>                  user_data)</programlisting>
<para>Signals that the pointer has entered the widget.</para>
<refsect3 id="GtkEventControllerMotion-enter.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>controller</para></entry>
<entry role="parameter_description"><para>the object which received the signal</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>x</para></entry>
<entry role="parameter_description"><para>coordinates of pointer location</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>y</para></entry>
<entry role="parameter_description"><para>coordinates of pointer location</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>mode</para></entry>
<entry role="parameter_description"><para>crossing mode</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="GtkEventControllerMotion-leave" role="signal"><title>The <literal>“leave”</literal> signal</title>
<indexterm zone="GtkEventControllerMotion-leave"><primary>GtkEventControllerMotion::leave</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
user_function (<link linkend="GtkEventControllerMotion"><type>GtkEventControllerMotion</type></link> *controller,
               <link linkend="GdkCrossingMode"><type>GdkCrossingMode</type></link>           mode,
               <link linkend="gpointer"><type>gpointer</type></link>                  user_data)</programlisting>
<para>Signals that the pointer has left the widget.</para>
<refsect3 id="GtkEventControllerMotion-leave.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>controller</para></entry>
<entry role="parameter_description"><para>the object which received the signal</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>mode</para></entry>
<entry role="parameter_description"><para>crossing mode</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="GtkEventControllerMotion-motion" role="signal"><title>The <literal>“motion”</literal> signal</title>
<indexterm zone="GtkEventControllerMotion-motion"><primary>GtkEventControllerMotion::motion</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
user_function (<link linkend="GtkEventControllerMotion"><type>GtkEventControllerMotion</type></link> *controller,
               <link linkend="gdouble"><type>gdouble</type></link>                   x,
               <link linkend="gdouble"><type>gdouble</type></link>                   y,
               <link linkend="gpointer"><type>gpointer</type></link>                  user_data)</programlisting>
<para>Emitted when the pointer moves inside the widget.</para>
<refsect3 id="GtkEventControllerMotion-motion.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>controller</para></entry>
<entry role="parameter_description"><para>The object that received the signal</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>x</para></entry>
<entry role="parameter_description"><para>the x coordinate</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>y</para></entry>
<entry role="parameter_description"><para>the y coordinate</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-FIRST:CAPS">Run First</link></para>
</refsect2>
</refsect1>
<refsect1 id="GtkEventControllerMotion.see-also">
<title>See Also</title>
<para><link linkend="GtkEventController"><type>GtkEventController</type></link></para>

</refsect1>

</refentry>
