<root>
<enum name="GdkAxisUse">
<description>
An enumeration describing the way in which a device
axis (valuator) maps onto the predefined valuator
types that GTK+ understands.

</description>
<parameters>
<parameter name="GDK_AXIS_IGNORE">
<parameter_description> the axis is ignored.
</parameter_description>
</parameter>
<parameter name="GDK_AXIS_X">
<parameter_description> the axis is used as the x axis.
</parameter_description>
</parameter>
<parameter name="GDK_AXIS_Y">
<parameter_description> the axis is used as the y axis.
</parameter_description>
</parameter>
<parameter name="GDK_AXIS_PRESSURE">
<parameter_description> the axis is used for pressure information.
</parameter_description>
</parameter>
<parameter name="GDK_AXIS_XTILT">
<parameter_description> the axis is used for x tilt information.
</parameter_description>
</parameter>
<parameter name="GDK_AXIS_YTILT">
<parameter_description> the axis is used for y tilt information.
</parameter_description>
</parameter>
<parameter name="GDK_AXIS_WHEEL">
<parameter_description> the axis is used for wheel information.
</parameter_description>
</parameter>
<parameter name="GDK_AXIS_LAST">
<parameter_description> a constant equal to the numerically highest axis value.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkByteOrder">
<description>
A set of values describing the possible byte-orders
for storing pixel values in memory.

</description>
<parameters>
<parameter name="GDK_LSB_FIRST">
<parameter_description> The values are stored with the least-significant byte
first. For instance, the 32-bit value 0xffeecc would be stored
in memory as 0xcc, 0xee, 0xff, 0x00.
</parameter_description>
</parameter>
<parameter name="GDK_MSB_FIRST">
<parameter_description> The values are stored with the most-significant byte
first. For instance, the 32-bit value 0xffeecc would be stored
in memory as 0x00, 0xff, 0xee, 0xcc.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkColorspace">
<description>
This enumeration defines the color spaces that are supported by
the &amp;gdk-pixbuf; library.  Currently only RGB is supported.

</description>
<parameters>
<parameter name="GDK_COLORSPACE_RGB">
<parameter_description> Indicates a red/green/blue additive color space.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkCrossingMode">
<description>
Specifies the crossing mode for #GdkEventCrossing.

</description>
<parameters>
<parameter name="GDK_CROSSING_NORMAL">
<parameter_description> crossing because of pointer motion.
</parameter_description>
</parameter>
<parameter name="GDK_CROSSING_GRAB">
<parameter_description> crossing because a grab is activated.
</parameter_description>
</parameter>
<parameter name="GDK_CROSSING_UNGRAB">
<parameter_description> crossing because a grab is deactivated.
</parameter_description>
</parameter>
<parameter name="GDK_CROSSING_GTK_GRAB">
<parameter_description> crossing because a GTK+ grab is activated.
</parameter_description>
</parameter>
<parameter name="GDK_CROSSING_GTK_UNGRAB">
<parameter_description> crossing because a GTK+ grab is deactivated.
</parameter_description>
</parameter>
<parameter name="GDK_CROSSING_STATE_CHANGED">
<parameter_description> crossing because a GTK+ widget changed
state (e.g. sensitivity).
</parameter_description>
</parameter>
<parameter name="GDK_CROSSING_TOUCH_BEGIN">
<parameter_description> crossing because a touch sequence has begun,
this event is synthetic as the pointer might have not left the window.
</parameter_description>
</parameter>
<parameter name="GDK_CROSSING_TOUCH_END">
<parameter_description> crossing because a touch sequence has ended,
this event is synthetic as the pointer might have not left the window.
</parameter_description>
</parameter>
<parameter name="GDK_CROSSING_DEVICE_SWITCH">
<parameter_description> crossing because of a device switch (i.e.
a mouse taking control of the pointer after a touch device), this event
is synthetic as the pointer didn't leave the window.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkCursorType">
<description>
The standard cursors available.

</description>
<parameters>
<parameter name="GDK_X_CURSOR">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;X_cursor.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_ARROW">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;arrow.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_BASED_ARROW_DOWN">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;based_arrow_down.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_BASED_ARROW_UP">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;based_arrow_up.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_BOAT">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;boat.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_BOGOSITY">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;bogosity.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_BOTTOM_LEFT_CORNER">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;bottom_left_corner.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_BOTTOM_RIGHT_CORNER">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;bottom_right_corner.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_BOTTOM_SIDE">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;bottom_side.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_BOTTOM_TEE">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;bottom_tee.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_BOX_SPIRAL">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;box_spiral.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_CENTER_PTR">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;center_ptr.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_CIRCLE">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;circle.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_CLOCK">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;clock.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_COFFEE_MUG">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;coffee_mug.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_CROSS">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;cross.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_CROSS_REVERSE">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;cross_reverse.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_CROSSHAIR">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;crosshair.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_DIAMOND_CROSS">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;diamond_cross.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_DOT">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;dot.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_DOTBOX">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;dotbox.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_DOUBLE_ARROW">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;double_arrow.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_DRAFT_LARGE">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;draft_large.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_DRAFT_SMALL">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;draft_small.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_DRAPED_BOX">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;draped_box.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_EXCHANGE">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;exchange.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_FLEUR">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;fleur.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_GOBBLER">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;gobbler.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_GUMBY">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;gumby.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_HAND1">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;hand1.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_HAND2">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;hand2.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_HEART">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;heart.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_ICON">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;icon.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_IRON_CROSS">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;iron_cross.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_LEFT_PTR">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;left_ptr.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_LEFT_SIDE">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;left_side.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_LEFT_TEE">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;left_tee.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_LEFTBUTTON">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;leftbutton.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_LL_ANGLE">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;ll_angle.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_LR_ANGLE">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;lr_angle.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_MAN">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;man.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_MIDDLEBUTTON">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;middlebutton.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_MOUSE">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;mouse.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_PENCIL">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;pencil.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_PIRATE">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;pirate.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_PLUS">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;plus.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_QUESTION_ARROW">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;question_arrow.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_RIGHT_PTR">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;right_ptr.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_RIGHT_SIDE">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;right_side.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_RIGHT_TEE">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;right_tee.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_RIGHTBUTTON">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;rightbutton.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_RTL_LOGO">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;rtl_logo.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_SAILBOAT">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;sailboat.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_SB_DOWN_ARROW">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;sb_down_arrow.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_SB_H_DOUBLE_ARROW">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;sb_h_double_arrow.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_SB_LEFT_ARROW">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;sb_left_arrow.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_SB_RIGHT_ARROW">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;sb_right_arrow.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_SB_UP_ARROW">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;sb_up_arrow.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_SB_V_DOUBLE_ARROW">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;sb_v_double_arrow.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_SHUTTLE">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;shuttle.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_SIZING">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;sizing.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_SPIDER">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;spider.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_SPRAYCAN">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;spraycan.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_STAR">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;star.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_TARGET">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;target.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_TCROSS">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;tcross.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_TOP_LEFT_ARROW">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;top_left_arrow.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_TOP_LEFT_CORNER">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;top_left_corner.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_TOP_RIGHT_CORNER">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;top_right_corner.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_TOP_SIDE">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;top_side.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_TOP_TEE">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;top_tee.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_TREK">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;trek.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_UL_ANGLE">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;ul_angle.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_UMBRELLA">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;umbrella.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_UR_ANGLE">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;ur_angle.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_WATCH">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;watch.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_XTERM">
<parameter_description> &lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;xterm.png&quot;&gt;&lt;/inlinegraphic&gt;
</parameter_description>
</parameter>
<parameter name="GDK_LAST_CURSOR">
<parameter_description> last cursor type
</parameter_description>
</parameter>
<parameter name="GDK_BLANK_CURSOR">
<parameter_description> Blank cursor. Since 2.16
</parameter_description>
</parameter>
<parameter name="GDK_CURSOR_IS_PIXMAP">
<parameter_description> type of cursors constructed with
gdk_cursor_new_from_pixbuf()
</parameter_description>
</parameter>
</parameters>
</enum>

<signal name="GdkDevice::changed">
<description>
The ::changed signal is emitted either when the #GdkDevice
has changed the number of either axes or keys. For example
In X this will normally happen when the slave device routing
events through the master device changes (for example, user
switches from the USB mouse to a tablet), in that case the
master device will change to reflect the new slave device
axes and keys.

</description>
<parameters>
<parameter name="device">
<parameter_description> the #GdkDevice that changed.
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<signal name="GdkDeviceManager::device-added">
<description>
The ::device-added signal is emitted either when a new master
pointer is created, or when a slave (Hardware) input device
is plugged in.

</description>
<parameters>
<parameter name="device_manager">
<parameter_description> the object on which the signal is emitted
</parameter_description>
</parameter>
<parameter name="device">
<parameter_description> the newly added #GdkDevice.
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<signal name="GdkDeviceManager::device-changed">
<description>
The ::device-changed signal is emitted whenever a device
has changed in the hierarchy, either slave devices being
disconnected from their master device or connected to
another one, or master devices being added or removed
a slave device.

If a slave device is detached from all master devices
(gdk_device_get_associated_device() returns %NULL), its
#GdkDeviceType will change to %GDK_DEVICE_TYPE_FLOATING,
if it's attached, it will change to %GDK_DEVICE_TYPE_SLAVE.

</description>
<parameters>
<parameter name="device_manager">
<parameter_description> the object on which the signal is emitted
</parameter_description>
</parameter>
<parameter name="device">
<parameter_description> the #GdkDevice that changed.
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<signal name="GdkDeviceManager::device-removed">
<description>
The ::device-removed signal is emitted either when a master
pointer is removed, or when a slave (Hardware) input device
is unplugged.

</description>
<parameters>
<parameter name="device_manager">
<parameter_description> the object on which the signal is emitted
</parameter_description>
</parameter>
<parameter name="device">
<parameter_description> the just removed #GdkDevice.
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<enum name="GdkDeviceType">
<description>
Indicates the device type. See &lt;link linkend=&quot;GdkDeviceManager.description&quot;&gt;above&lt;/link&gt;
for more information about the meaning of these device types.

</description>
<parameters>
<parameter name="GDK_DEVICE_TYPE_MASTER">
<parameter_description> Device is a master (or virtual) device. There will
be an associated focus indicator on the screen.
</parameter_description>
</parameter>
<parameter name="GDK_DEVICE_TYPE_SLAVE">
<parameter_description> Device is a slave (or physical) device.
</parameter_description>
</parameter>
<parameter name="GDK_DEVICE_TYPE_FLOATING">
<parameter_description> Device is a physical device, currently not attached to
any virtual device.
</parameter_description>
</parameter>
</parameters>
</enum>

<signal name="GdkDisplay::closed">
<description>
The ::closed signal is emitted when the connection to the windowing
system for @display is closed.

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description> the object on which the signal is emitted
</parameter_description>
</parameter>
<parameter name="is_error">
<parameter_description> %TRUE if the display was closed due to an error
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<signal name="GdkDisplay::opened">
<description>
The ::opened signal is emitted when the connection to the windowing
system for @display is opened.

</description>
<parameters>
<parameter name="display">
<parameter_description> the object on which the signal is emitted
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<signal name="GdkDisplayManager::display-opened">
<description>
The ::display-opened signal is emitted when a display is opened.

Since: 2.2

</description>
<parameters>
<parameter name="manager">
<parameter_description> the object on which the signal is emitted
</parameter_description>
</parameter>
<parameter name="display">
<parameter_description> the opened display
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<enum name="GdkDragAction">
<description>
Used in #GdkDragContext to indicate what the destination
should do with the dropped data.

</description>
<parameters>
<parameter name="GDK_ACTION_DEFAULT">
<parameter_description> Means nothing, and should not be used.
</parameter_description>
</parameter>
<parameter name="GDK_ACTION_COPY">
<parameter_description> Copy the data.
</parameter_description>
</parameter>
<parameter name="GDK_ACTION_MOVE">
<parameter_description> Move the data, i.e. first copy it, then delete
it from the source using the DELETE target of the X selection protocol.
</parameter_description>
</parameter>
<parameter name="GDK_ACTION_LINK">
<parameter_description> Add a link to the data. Note that this is only
useful if source and destination agree on what it means.
</parameter_description>
</parameter>
<parameter name="GDK_ACTION_PRIVATE">
<parameter_description> Special action which tells the source that the
destination will do something that the source doesn't understand.
</parameter_description>
</parameter>
<parameter name="GDK_ACTION_ASK">
<parameter_description> Ask the user what to do with the data.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkDragProtocol">
<description>
Used in #GdkDragContext to indicate the protocol according to
which DND is done.

</description>
<parameters>
<parameter name="GDK_DRAG_PROTO_NONE">
<parameter_description> no protocol.
</parameter_description>
</parameter>
<parameter name="GDK_DRAG_PROTO_MOTIF">
<parameter_description> The Motif DND protocol.
</parameter_description>
</parameter>
<parameter name="GDK_DRAG_PROTO_XDND">
<parameter_description> The Xdnd protocol.
</parameter_description>
</parameter>
<parameter name="GDK_DRAG_PROTO_ROOTWIN">
<parameter_description> An extension to the Xdnd protocol for
unclaimed root window drops.
</parameter_description>
</parameter>
<parameter name="GDK_DRAG_PROTO_WIN32_DROPFILES">
<parameter_description> The simple WM_DROPFILES protocol.
</parameter_description>
</parameter>
<parameter name="GDK_DRAG_PROTO_OLE2">
<parameter_description> The complex OLE2 DND protocol (not implemented).
</parameter_description>
</parameter>
<parameter name="GDK_DRAG_PROTO_LOCAL">
<parameter_description> Intra-application DND.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkEventMask">
<description>
A set of bit-flags to indicate which events a window is to receive.
Most of these masks map onto one or more of the #GdkEventType event types
above.

%GDK_POINTER_MOTION_HINT_MASK is a special mask which is used to reduce the
number of %GDK_MOTION_NOTIFY events received. Normally a %GDK_MOTION_NOTIFY
event is received each time the mouse moves. However, if the application
spends a lot of time processing the event (updating the display, for example),
it can lag behind the position of the mouse. When using
%GDK_POINTER_MOTION_HINT_MASK, fewer %GDK_MOTION_NOTIFY events will be sent,
some of which are marked as a hint (the is_hint member is %TRUE).
To receive more motion events after a motion hint event, the application
needs to asks for more, by calling gdk_event_request_motions().

If %GDK_TOUCH_MASK is enabled, the window will receive touch events
from touch-enabled devices. Those will come as sequences of #GdkEventTouch
with type %GDK_TOUCH_UPDATE, enclosed by two events with
type %GDK_TOUCH_BEGIN and %GDK_TOUCH_END (or %GDK_TOUCH_CANCEL).
gdk_event_get_event_sequence() returns the event sequence for these
events, so different sequences may be distinguished.

</description>
<parameters>
<parameter name="GDK_EXPOSURE_MASK">
<parameter_description> receive expose events
</parameter_description>
</parameter>
<parameter name="GDK_POINTER_MOTION_MASK">
<parameter_description> receive all pointer motion events
</parameter_description>
</parameter>
<parameter name="GDK_POINTER_MOTION_HINT_MASK">
<parameter_description> see the explanation above
</parameter_description>
</parameter>
<parameter name="GDK_BUTTON_MOTION_MASK">
<parameter_description> receive pointer motion events while any button is pressed
</parameter_description>
</parameter>
<parameter name="GDK_BUTTON1_MOTION_MASK">
<parameter_description> receive pointer motion events while 1 button is pressed
</parameter_description>
</parameter>
<parameter name="GDK_BUTTON2_MOTION_MASK">
<parameter_description> receive pointer motion events while 2 button is pressed
</parameter_description>
</parameter>
<parameter name="GDK_BUTTON3_MOTION_MASK">
<parameter_description> receive pointer motion events while 3 button is pressed
</parameter_description>
</parameter>
<parameter name="GDK_BUTTON_PRESS_MASK">
<parameter_description> receive button press events
</parameter_description>
</parameter>
<parameter name="GDK_BUTTON_RELEASE_MASK">
<parameter_description> receive button release events
</parameter_description>
</parameter>
<parameter name="GDK_KEY_PRESS_MASK">
<parameter_description> receive key press events
</parameter_description>
</parameter>
<parameter name="GDK_KEY_RELEASE_MASK">
<parameter_description> receive key release events
</parameter_description>
</parameter>
<parameter name="GDK_ENTER_NOTIFY_MASK">
<parameter_description> receive window enter events
</parameter_description>
</parameter>
<parameter name="GDK_LEAVE_NOTIFY_MASK">
<parameter_description> receive window leave events
</parameter_description>
</parameter>
<parameter name="GDK_FOCUS_CHANGE_MASK">
<parameter_description> receive focus change events
</parameter_description>
</parameter>
<parameter name="GDK_STRUCTURE_MASK">
<parameter_description> receive events about window configuration change
</parameter_description>
</parameter>
<parameter name="GDK_PROPERTY_CHANGE_MASK">
<parameter_description> receive property change events
</parameter_description>
</parameter>
<parameter name="GDK_VISIBILITY_NOTIFY_MASK">
<parameter_description> receive visibility change events
</parameter_description>
</parameter>
<parameter name="GDK_PROXIMITY_IN_MASK">
<parameter_description> receive proximity in events
</parameter_description>
</parameter>
<parameter name="GDK_PROXIMITY_OUT_MASK">
<parameter_description> receive proximity out events
</parameter_description>
</parameter>
<parameter name="GDK_SUBSTRUCTURE_MASK">
<parameter_description> receive events about window configuration changes of
child windows
</parameter_description>
</parameter>
<parameter name="GDK_SCROLL_MASK">
<parameter_description> receive scroll events
</parameter_description>
</parameter>
<parameter name="GDK_TOUCH_MASK">
<parameter_description> receive touch events. Since 3.4
</parameter_description>
</parameter>
<parameter name="GDK_SMOOTH_SCROLL_MASK">
<parameter_description> receive smooth scrolling events. Since 3.4
</parameter_description>
</parameter>
<parameter name="GDK_ALL_EVENTS_MASK">
<parameter_description> the combination of all the above event masks.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkEventType">
<description>
Specifies the type of the event.

Do not confuse these events with the signals that GTK+ widgets emit.
Although many of these events result in corresponding signals being emitted,
the events are often transformed or filtered along the way.

In some language bindings, the values %GDK_2BUTTON_PRESS and
%GDK_3BUTTON_PRESS would translate into something syntactically
invalid (eg &lt;literal&gt;Gdk.EventType.2ButtonPress&lt;/literal&gt;, where a
symbol is not allowed to start with a number). In that case, the
aliases %GDK_DOUBLE_BUTTON_PRESS and %GDK_TRIPLE_BUTTON_PRESS can
be used instead.

</description>
<parameters>
<parameter name="GDK_NOTHING">
<parameter_description> a special code to indicate a null event.
</parameter_description>
</parameter>
<parameter name="GDK_DELETE">
<parameter_description> the window manager has requested that the toplevel window be
hidden or destroyed, usually when the user clicks on a special icon in the
title bar.
</parameter_description>
</parameter>
<parameter name="GDK_DESTROY">
<parameter_description> the window has been destroyed.
</parameter_description>
</parameter>
<parameter name="GDK_EXPOSE">
<parameter_description> all or part of the window has become visible and needs to be
redrawn.
</parameter_description>
</parameter>
<parameter name="GDK_MOTION_NOTIFY">
<parameter_description> the pointer (usually a mouse) has moved.
</parameter_description>
</parameter>
<parameter name="GDK_BUTTON_PRESS">
<parameter_description> a mouse button has been pressed.
</parameter_description>
</parameter>
<parameter name="GDK_2BUTTON_PRESS">
<parameter_description> a mouse button has been double-clicked (clicked twice
within a short period of time). Note that each click also generates a
%GDK_BUTTON_PRESS event.
</parameter_description>
</parameter>
<parameter name="GDK_DOUBLE_BUTTON_PRESS">
<parameter_description> alias for %GDK_2BUTTON_PRESS, added in 3.6.
</parameter_description>
</parameter>
<parameter name="GDK_3BUTTON_PRESS">
<parameter_description> a mouse button has been clicked 3 times in a short period
of time. Note that each click also generates a %GDK_BUTTON_PRESS event.
</parameter_description>
</parameter>
<parameter name="GDK_TRIPLE_BUTTON_PRESS">
<parameter_description> alias for %GDK_3BUTTON_PRESS, added in 3.6.
</parameter_description>
</parameter>
<parameter name="GDK_BUTTON_RELEASE">
<parameter_description> a mouse button has been released.
</parameter_description>
</parameter>
<parameter name="GDK_KEY_PRESS">
<parameter_description> a key has been pressed.
</parameter_description>
</parameter>
<parameter name="GDK_KEY_RELEASE">
<parameter_description> a key has been released.
</parameter_description>
</parameter>
<parameter name="GDK_ENTER_NOTIFY">
<parameter_description> the pointer has entered the window.
</parameter_description>
</parameter>
<parameter name="GDK_LEAVE_NOTIFY">
<parameter_description> the pointer has left the window.
</parameter_description>
</parameter>
<parameter name="GDK_FOCUS_CHANGE">
<parameter_description> the keyboard focus has entered or left the window.
</parameter_description>
</parameter>
<parameter name="GDK_CONFIGURE">
<parameter_description> the size, position or stacking order of the window has changed.
Note that GTK+ discards these events for %GDK_WINDOW_CHILD windows.
</parameter_description>
</parameter>
<parameter name="GDK_MAP">
<parameter_description> the window has been mapped.
</parameter_description>
</parameter>
<parameter name="GDK_UNMAP">
<parameter_description> the window has been unmapped.
</parameter_description>
</parameter>
<parameter name="GDK_PROPERTY_NOTIFY">
<parameter_description> a property on the window has been changed or deleted.
</parameter_description>
</parameter>
<parameter name="GDK_SELECTION_CLEAR">
<parameter_description> the application has lost ownership of a selection.
</parameter_description>
</parameter>
<parameter name="GDK_SELECTION_REQUEST">
<parameter_description> another application has requested a selection.
</parameter_description>
</parameter>
<parameter name="GDK_SELECTION_NOTIFY">
<parameter_description> a selection has been received.
</parameter_description>
</parameter>
<parameter name="GDK_PROXIMITY_IN">
<parameter_description> an input device has moved into contact with a sensing
surface (e.g. a touchscreen or graphics tablet).
</parameter_description>
</parameter>
<parameter name="GDK_PROXIMITY_OUT">
<parameter_description> an input device has moved out of contact with a sensing
surface.
</parameter_description>
</parameter>
<parameter name="GDK_DRAG_ENTER">
<parameter_description> the mouse has entered the window while a drag is in progress.
</parameter_description>
</parameter>
<parameter name="GDK_DRAG_LEAVE">
<parameter_description> the mouse has left the window while a drag is in progress.
</parameter_description>
</parameter>
<parameter name="GDK_DRAG_MOTION">
<parameter_description> the mouse has moved in the window while a drag is in
progress.
</parameter_description>
</parameter>
<parameter name="GDK_DRAG_STATUS">
<parameter_description> the status of the drag operation initiated by the window
has changed.
</parameter_description>
</parameter>
<parameter name="GDK_DROP_START">
<parameter_description> a drop operation onto the window has started.
</parameter_description>
</parameter>
<parameter name="GDK_DROP_FINISHED">
<parameter_description> the drop operation initiated by the window has completed.
</parameter_description>
</parameter>
<parameter name="GDK_CLIENT_EVENT">
<parameter_description> a message has been received from another application.
</parameter_description>
</parameter>
<parameter name="GDK_VISIBILITY_NOTIFY">
<parameter_description> the window visibility status has changed.
</parameter_description>
</parameter>
<parameter name="GDK_SCROLL">
<parameter_description> the scroll wheel was turned
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_STATE">
<parameter_description> the state of a window has changed. See #GdkWindowState
for the possible window states
</parameter_description>
</parameter>
<parameter name="GDK_SETTING">
<parameter_description> a setting has been modified.
</parameter_description>
</parameter>
<parameter name="GDK_OWNER_CHANGE">
<parameter_description> the owner of a selection has changed. This event type
was added in 2.6
</parameter_description>
</parameter>
<parameter name="GDK_GRAB_BROKEN">
<parameter_description> a pointer or keyboard grab was broken. This event type
was added in 2.8.
</parameter_description>
</parameter>
<parameter name="GDK_DAMAGE">
<parameter_description> the content of the window has been changed. This event type
was added in 2.14.
</parameter_description>
</parameter>
<parameter name="GDK_TOUCH_BEGIN">
<parameter_description> A new touch event sequence has just started. This event
type was added in 3.4.
</parameter_description>
</parameter>
<parameter name="GDK_TOUCH_UPDATE">
<parameter_description> A touch event sequence has been updated. This event type
was added in 3.4.
</parameter_description>
</parameter>
<parameter name="GDK_TOUCH_END">
<parameter_description> A touch event sequence has finished. This event type
was added in 3.4.
</parameter_description>
</parameter>
<parameter name="GDK_TOUCH_CANCEL">
<parameter_description> A touch event sequence has been canceled. This event type
was added in 3.4.
</parameter_description>
</parameter>
<parameter name="GDK_EVENT_LAST">
<parameter_description> marks the end of the GdkEventType enumeration. Added in 2.18
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkFilterReturn">
<description>
Specifies the result of applying a #GdkFilterFunc to a native event.

</description>
<parameters>
<parameter name="GDK_FILTER_CONTINUE">
<parameter_description> event not handled, continue processing.
</parameter_description>
</parameter>
<parameter name="GDK_FILTER_TRANSLATE">
<parameter_description> native event translated into a GDK event and stored
in the &lt;literal&gt;event&lt;/literal&gt; structure that was passed in.
</parameter_description>
</parameter>
<parameter name="GDK_FILTER_REMOVE">
<parameter_description> event handled, terminate processing.
</parameter_description>
</parameter>
</parameters>
</enum>

<signal name="GdkFrameClock::after-paint">
<description>
This signal ends processing of the frame. Applications
should generally not handle this signal.

</description>
<parameters>
<parameter name="clock">
<parameter_description> the frame clock emitting the signal
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<signal name="GdkFrameClock::before-paint">
<description>
This signal begins processing of the frame. Applications
should generally not handle this signal.

</description>
<parameters>
<parameter name="clock">
<parameter_description> the frame clock emitting the signal
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<signal name="GdkFrameClock::flush-events">
<description>
This signal is used to flush pending motion events that
are being batched up and compressed together. Applications
should not handle this signal.

</description>
<parameters>
<parameter name="clock">
<parameter_description> the frame clock emitting the signal
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<signal name="GdkFrameClock::layout">
<description>
This signal is emitted as the second step of toolkit and
application processing of the frame. Any work to update
sizes and positions of application elements should be
performed. GTK+ normally handles this internally.

</description>
<parameters>
<parameter name="clock">
<parameter_description> the frame clock emitting the signal
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<signal name="GdkFrameClock::paint">
<description>
This signal is emitted as the third step of toolkit and
application processing of the frame. The frame is
repainted. GDK normally handles this internally and
produces expose events, which are turned into GTK+
#GtkWidget::draw signals.

</description>
<parameters>
<parameter name="clock">
<parameter_description> the frame clock emitting the signal
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<signal name="GdkFrameClock::resume-events">
<description>
This signal is emitted after processing of the frame is
finished, and is handled internally by GTK+ to resume normal
event processing. Applications should not handle this signal.

</description>
<parameters>
<parameter name="clock">
<parameter_description> the frame clock emitting the signal
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<signal name="GdkFrameClock::update">
<description>
This signal is emitted as the first step of toolkit and
application processing of the frame. Animations should
be updated using gdk_frame_clock_get_frame_time().
Applications can connect directly to this signal, or
use gtk_widget_add_tick_callback() as a more convenient
interface.

</description>
<parameters>
<parameter name="clock">
<parameter_description> the frame clock emitting the signal
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<enum name="GdkFrameClockPhase">
<description>
#GdkFrameClockPhase is used to represent the different paint clock
phases that can be requested. The elements of the enumeration
correspond to the signals of #GdkPaintClock.

Since: 3.8

</description>
<parameters>
<parameter name="GDK_FRAME_CLOCK_PHASE_NONE">
<parameter_description> no phase
</parameter_description>
</parameter>
<parameter name="GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS">
<parameter_description> corresponds to GdkFrameClock::flush-events. Should not be handled by applications.
</parameter_description>
</parameter>
<parameter name="GDK_FRAME_CLOCK_PHASE_BEFORE_PAINT">
<parameter_description> corresponds to GdkFrameClock::before-paint. Should not be handled by applications.
</parameter_description>
</parameter>
<parameter name="GDK_FRAME_CLOCK_PHASE_UPDATE">
<parameter_description> corresponds to GdkFrameClock::update.
</parameter_description>
</parameter>
<parameter name="GDK_FRAME_CLOCK_PHASE_LAYOUT">
<parameter_description> corresponds to GdkFrameClock::layout.
</parameter_description>
</parameter>
<parameter name="GDK_FRAME_CLOCK_PHASE_PAINT">
<parameter_description> corresponds to GdkFrameClock::paint.
</parameter_description>
</parameter>
<parameter name="GDK_FRAME_CLOCK_PHASE_RESUME_EVENTS">
<parameter_description> corresponds to GdkFrameClock::resume-events. Should not be handled by applications.
</parameter_description>
</parameter>
<parameter name="GDK_FRAME_CLOCK_PHASE_AFTER_PAINT">
<parameter_description> corresponds to GdkFrameClock::after-paint. Should not be handled by applications.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkFullscreenMode">
<description>
Indicates which monitor (in a multi-head setup) a window should span over
when in fullscreen mode.

Since: 3.8

</description>
<parameters>
<parameter name="GDK_FULLSCREEN_ON_CURRENT_MONITOR">
<parameter_description> Fullscreen on current monitor only.
</parameter_description>
</parameter>
<parameter name="GDK_FULLSCREEN_ON_ALL_MONITORS">
<parameter_description> Span across all monitors when fullscreen.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkGrabOwnership">
<description>
Defines how device grabs interact with other devices.

</description>
<parameters>
<parameter name="GDK_OWNERSHIP_NONE">
<parameter_description> All other devices' events are allowed.
</parameter_description>
</parameter>
<parameter name="GDK_OWNERSHIP_WINDOW">
<parameter_description> Other devices' events are blocked for the grab window.
</parameter_description>
</parameter>
<parameter name="GDK_OWNERSHIP_APPLICATION">
<parameter_description> Other devices' events are blocked for the whole application.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkGrabStatus">
<description>
Returned by gdk_pointer_grab() and gdk_keyboard_grab() to indicate
success or the reason for the failure of the grab attempt.

</description>
<parameters>
<parameter name="GDK_GRAB_SUCCESS">
<parameter_description> the resource was successfully grabbed.
</parameter_description>
</parameter>
<parameter name="GDK_GRAB_ALREADY_GRABBED">
<parameter_description> the resource is actively grabbed by another client.
</parameter_description>
</parameter>
<parameter name="GDK_GRAB_INVALID_TIME">
<parameter_description> the resource was grabbed more recently than the
specified time.
</parameter_description>
</parameter>
<parameter name="GDK_GRAB_NOT_VIEWABLE">
<parameter_description> the grab window or the @confine_to window are not
viewable.
</parameter_description>
</parameter>
<parameter name="GDK_GRAB_FROZEN">
<parameter_description> the resource is frozen by an active grab of another client.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkGravity">
<description>
Defines the reference point of a window and the meaning of coordinates
passed to gtk_window_move(). See gtk_window_move() and the &quot;implementation
notes&quot; section of the
&lt;ulink url=&quot;http://www.freedesktop.org/Standards/wm-spec&quot;&gt;Extended
Window Manager Hints&lt;/ulink&gt; specification for more details.

</description>
<parameters>
<parameter name="GDK_GRAVITY_NORTH_WEST">
<parameter_description> the reference point is at the top left corner.
</parameter_description>
</parameter>
<parameter name="GDK_GRAVITY_NORTH">
<parameter_description> the reference point is in the middle of the top edge.
</parameter_description>
</parameter>
<parameter name="GDK_GRAVITY_NORTH_EAST">
<parameter_description> the reference point is at the top right corner.
</parameter_description>
</parameter>
<parameter name="GDK_GRAVITY_WEST">
<parameter_description> the reference point is at the middle of the left edge.
</parameter_description>
</parameter>
<parameter name="GDK_GRAVITY_CENTER">
<parameter_description> the reference point is at the center of the window.
</parameter_description>
</parameter>
<parameter name="GDK_GRAVITY_EAST">
<parameter_description> the reference point is at the middle of the right edge.
</parameter_description>
</parameter>
<parameter name="GDK_GRAVITY_SOUTH_WEST">
<parameter_description> the reference point is at the lower left corner.
</parameter_description>
</parameter>
<parameter name="GDK_GRAVITY_SOUTH">
<parameter_description> the reference point is at the middle of the lower edge.
</parameter_description>
</parameter>
<parameter name="GDK_GRAVITY_SOUTH_EAST">
<parameter_description> the reference point is at the lower right corner.
</parameter_description>
</parameter>
<parameter name="GDK_GRAVITY_STATIC">
<parameter_description> the reference point is at the top left corner of the
window itself, ignoring window manager decorations.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkInputMode">
<description>
An enumeration that describes the mode of an input device.

</description>
<parameters>
<parameter name="GDK_MODE_DISABLED">
<parameter_description> the device is disabled and will not report any events.
</parameter_description>
</parameter>
<parameter name="GDK_MODE_SCREEN">
<parameter_description> the device is enabled. The device's coordinate space
maps to the entire screen.
</parameter_description>
</parameter>
<parameter name="GDK_MODE_WINDOW">
<parameter_description> the device is enabled. The device's coordinate space
is mapped to a single window. The manner in which this window
is chosen is undefined, but it will typically be the same
way in which the focus window for key events is determined.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkInputSource">
<description>
An enumeration describing the type of an input device in general terms.

</description>
<parameters>
<parameter name="GDK_SOURCE_MOUSE">
<parameter_description> the device is a mouse. (This will be reported for the core
pointer, even if it is something else, such as a trackball.)
</parameter_description>
</parameter>
<parameter name="GDK_SOURCE_PEN">
<parameter_description> the device is a stylus of a graphics tablet or similar device.
</parameter_description>
</parameter>
<parameter name="GDK_SOURCE_ERASER">
<parameter_description> the device is an eraser. Typically, this would be the other end
of a stylus on a graphics tablet.
</parameter_description>
</parameter>
<parameter name="GDK_SOURCE_CURSOR">
<parameter_description> the device is a graphics tablet &quot;puck&quot; or similar device.
</parameter_description>
</parameter>
<parameter name="GDK_SOURCE_KEYBOARD">
<parameter_description> the device is a keyboard.
</parameter_description>
</parameter>
<parameter name="GDK_SOURCE_TOUCHSCREEN">
<parameter_description> the device is a direct-input touch device, such
as a touchscreen or tablet. This device type has been added in 3.4.
</parameter_description>
</parameter>
<parameter name="GDK_SOURCE_TOUCHPAD">
<parameter_description> the device is an indirect touch device, such
as a touchpad. This device type has been added in 3.4.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkInterpType">
<description>
This enumeration describes the different interpolation modes that
can be used with the scaling functions. @GDK_INTERP_NEAREST is 
the fastest scaling method, but has horrible quality when 
scaling down. @GDK_INTERP_BILINEAR is the best choice if you 
aren't sure what to choose, it has a good speed/quality balance.

&lt;note&gt;
Cubic filtering is missing from the list; hyperbolic
interpolation is just as fast and results in higher quality.
&lt;/note&gt;

</description>
<parameters>
<parameter name="GDK_INTERP_NEAREST">
<parameter_description> Nearest neighbor sampling; this is the fastest
and lowest quality mode. Quality is normally unacceptable when scaling 
down, but may be OK when scaling up.
</parameter_description>
</parameter>
<parameter name="GDK_INTERP_TILES">
<parameter_description> This is an accurate simulation of the PostScript
image operator without any interpolation enabled.  Each pixel is
rendered as a tiny parallelogram of solid color, the edges of which
are implemented with antialiasing.  It resembles nearest neighbor for
enlargement, and bilinear for reduction.
</parameter_description>
</parameter>
<parameter name="GDK_INTERP_BILINEAR">
<parameter_description> Best quality/speed balance; use this mode by
default. Bilinear interpolation.  For enlargement, it is
equivalent to point-sampling the ideal bilinear-interpolated image.
For reduction, it is equivalent to laying down small tiles and
integrating over the coverage area.
</parameter_description>
</parameter>
<parameter name="GDK_INTERP_HYPER">
<parameter_description> This is the slowest and highest quality
reconstruction function. It is derived from the hyperbolic filters in
Wolberg's &quot;Digital Image Warping&quot;, and is formally defined as the
hyperbolic-filter sampling the ideal hyperbolic-filter interpolated
image (the filter is designed to be idempotent for 1:1 pixel mapping).
</parameter_description>
</parameter>
</parameters>
</enum>

<signal name="GdkKeymap::direction-changed">
<description>
The ::direction-changed signal gets emitted when the direction of
the keymap changes.

Since: 2.0

</description>
<parameters>
<parameter name="keymap">
<parameter_description> the object on which the signal is emitted
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<signal name="GdkKeymap::keys-changed">
<description>
The ::keys-changed signal is emitted when the mapping represented by
@keymap changes.

Since: 2.2

</description>
<parameters>
<parameter name="keymap">
<parameter_description> the object on which the signal is emitted
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<signal name="GdkKeymap::state-changed">
<description>
The ::state-changed signal is emitted when the state of the
keyboard changes, e.g when Caps Lock is turned on or off.
See gdk_keymap_get_caps_lock_state().

Since: 2.16

</description>
<parameters>
<parameter name="keymap">
<parameter_description> the object on which the signal is emitted
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<enum name="GdkModifierIntent">
<description>
This enum is used with gdk_keymap_get_modifier_mask() and
gdk_get_modifier_mask() in order to determine what modifiers the
currently used windowing system backend uses for particular
purposes. For example, on X11/Windows, the Control key is used for
invoking menu shortcuts (accelerators), whereas on Apple computers
it's the Command key (which correspond to %GDK_CONTROL_MASK and
%GDK_MOD2_MASK, respectively).

Since: 3.4

</description>
<parameters>
<parameter name="GDK_MODIFIER_INTENT_PRIMARY_ACCELERATOR">
<parameter_description> the primary modifier used to invoke
menu accelerators.
</parameter_description>
</parameter>
<parameter name="GDK_MODIFIER_INTENT_CONTEXT_MENU">
<parameter_description> the modifier used to invoke context menus.
Note that mouse button 3 always triggers context menus. When this modifier
is not 0, it &lt;strong&gt;additionally&lt;/strong&gt; triggers context menus when used
with mouse button 1.
</parameter_description>
</parameter>
<parameter name="GDK_MODIFIER_INTENT_EXTEND_SELECTION">
<parameter_description> the modifier used to extend selections
using &lt;modifier&gt;-click or &lt;modifier&gt;-cursor-key
</parameter_description>
</parameter>
<parameter name="GDK_MODIFIER_INTENT_MODIFY_SELECTION">
<parameter_description> the modifier used to modify selections,
which in most cases means toggling the clicked item into or out of the selection.
</parameter_description>
</parameter>
<parameter name="GDK_MODIFIER_INTENT_NO_TEXT_INPUT">
<parameter_description> when any of these modifiers is pressed, the
key event cannot produce a symbol directly. This is meant to be used for
input methods, and for use cases like typeahead search.
</parameter_description>
</parameter>
<parameter name="GDK_MODIFIER_INTENT_SHIFT_GROUP">
<parameter_description> the modifier that switches between keyboard
groups (AltGr on X11/Windows and Option/Alt on OS X).
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkModifierType">
<description>
A set of bit-flags to indicate the state of modifier keys and mouse buttons
in various event types. Typical modifier keys are Shift, Control, Meta,
Super, Hyper, Alt, Compose, Apple, CapsLock or ShiftLock.

Like the X Window System, GDK supports 8 modifier keys and 5 mouse buttons.

Since 2.10, GDK recognizes which of the Meta, Super or Hyper keys are mapped
to Mod2 - Mod5, and indicates this by setting %GDK_SUPER_MASK,
%GDK_HYPER_MASK or %GDK_META_MASK in the state field of key events.

Note that GDK may add internal values to events which include
reserved values such as %GDK_MODIFIER_RESERVED_13_MASK.  Your code
should preserve and ignore them.  You can use %GDK_MODIFIER_MASK to
remove all reserved values.

</description>
<parameters>
<parameter name="GDK_SHIFT_MASK">
<parameter_description> the Shift key.
</parameter_description>
</parameter>
<parameter name="GDK_LOCK_MASK">
<parameter_description> a Lock key (depending on the modifier mapping of the
X server this may either be CapsLock or ShiftLock).
</parameter_description>
</parameter>
<parameter name="GDK_CONTROL_MASK">
<parameter_description> the Control key.
</parameter_description>
</parameter>
<parameter name="GDK_MOD1_MASK">
<parameter_description> the fourth modifier key (it depends on the modifier
mapping of the X server which key is interpreted as this modifier, but
normally it is the Alt key).
</parameter_description>
</parameter>
<parameter name="GDK_MOD2_MASK">
<parameter_description> the fifth modifier key (it depends on the modifier
mapping of the X server which key is interpreted as this modifier).
</parameter_description>
</parameter>
<parameter name="GDK_MOD3_MASK">
<parameter_description> the sixth modifier key (it depends on the modifier
mapping of the X server which key is interpreted as this modifier).
</parameter_description>
</parameter>
<parameter name="GDK_MOD4_MASK">
<parameter_description> the seventh modifier key (it depends on the modifier
mapping of the X server which key is interpreted as this modifier).
</parameter_description>
</parameter>
<parameter name="GDK_MOD5_MASK">
<parameter_description> the eighth modifier key (it depends on the modifier
mapping of the X server which key is interpreted as this modifier).
</parameter_description>
</parameter>
<parameter name="GDK_BUTTON1_MASK">
<parameter_description> the first mouse button.
</parameter_description>
</parameter>
<parameter name="GDK_BUTTON2_MASK">
<parameter_description> the second mouse button.
</parameter_description>
</parameter>
<parameter name="GDK_BUTTON3_MASK">
<parameter_description> the third mouse button.
</parameter_description>
</parameter>
<parameter name="GDK_BUTTON4_MASK">
<parameter_description> the fourth mouse button.
</parameter_description>
</parameter>
<parameter name="GDK_BUTTON5_MASK">
<parameter_description> the fifth mouse button.
</parameter_description>
</parameter>
<parameter name="GDK_MODIFIER_RESERVED_13_MASK">
<parameter_description> A reserved bit flag; do not use in your own code
</parameter_description>
</parameter>
<parameter name="GDK_SUPER_MASK">
<parameter_description> the Super modifier. Since 2.10
</parameter_description>
</parameter>
<parameter name="GDK_HYPER_MASK">
<parameter_description> the Hyper modifier. Since 2.10
</parameter_description>
</parameter>
<parameter name="GDK_META_MASK">
<parameter_description> the Meta modifier. Since 2.10
</parameter_description>
</parameter>
<parameter name="GDK_RELEASE_MASK">
<parameter_description> not used in GDK itself. GTK+ uses it to differentiate
between (keyval, modifiers) pairs from key press and release events.
</parameter_description>
</parameter>
<parameter name="GDK_MODIFIER_MASK">
<parameter_description> a mask covering all modifier types.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkNotifyType">
<description>
Specifies the kind of crossing for #GdkEventCrossing.

See the X11 protocol specification of &lt;type&gt;LeaveNotify&lt;/type&gt; for
full details of crossing event generation.

</description>
<parameters>
<parameter name="GDK_NOTIFY_ANCESTOR">
<parameter_description> the window is entered from an ancestor or
left towards an ancestor.
</parameter_description>
</parameter>
<parameter name="GDK_NOTIFY_VIRTUAL">
<parameter_description> the pointer moves between an ancestor and an
inferior of the window.
</parameter_description>
</parameter>
<parameter name="GDK_NOTIFY_INFERIOR">
<parameter_description> the window is entered from an inferior or
left towards an inferior.
</parameter_description>
</parameter>
<parameter name="GDK_NOTIFY_NONLINEAR">
<parameter_description> the window is entered from or left towards
a window which is neither an ancestor nor an inferior.
</parameter_description>
</parameter>
<parameter name="GDK_NOTIFY_NONLINEAR_VIRTUAL">
<parameter_description> the pointer moves between two windows
which are not ancestors of each other and the window is part of
the ancestor chain between one of these windows and their least
common ancestor.
</parameter_description>
</parameter>
<parameter name="GDK_NOTIFY_UNKNOWN">
<parameter_description> an unknown type of enter/leave event occurred.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkOwnerChange">
<description>
Specifies why a selection ownership was changed.

</description>
<parameters>
<parameter name="GDK_OWNER_CHANGE_NEW_OWNER">
<parameter_description> some other app claimed the ownership
</parameter_description>
</parameter>
<parameter name="GDK_OWNER_CHANGE_DESTROY">
<parameter_description> the window was destroyed
</parameter_description>
</parameter>
<parameter name="GDK_OWNER_CHANGE_CLOSE">
<parameter_description> the client was closed
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkPixbufAlphaMode">
<description>
These values can be passed to
gdk_pixbuf_render_to_drawable_alpha() to control how the alpha
channel of an image should be handled.  This function can create a
bilevel clipping mask (black and white) and use it while painting
the image.  In the future, when the X Window System gets an alpha
channel extension, it will be possible to do full alpha
compositing onto arbitrary drawables.  For now both cases fall
back to a bilevel clipping mask.

</description>
<parameters>
<parameter name="GDK_PIXBUF_ALPHA_BILEVEL">
<parameter_description> A bilevel clipping mask (black and white)
will be created and used to draw the image.  Pixels below 0.5 opacity
will be considered fully transparent, and all others will be
considered fully opaque.
</parameter_description>
</parameter>
<parameter name="GDK_PIXBUF_ALPHA_FULL">
<parameter_description> For now falls back to #GDK_PIXBUF_ALPHA_BILEVEL.
In the future it will do full alpha compositing.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkPixbufError">
<description>
An error code in the #GDK_PIXBUF_ERROR domain. Many &amp;gdk-pixbuf;
operations can cause errors in this domain, or in the #G_FILE_ERROR
domain.

</description>
<parameters>
<parameter name="GDK_PIXBUF_ERROR_CORRUPT_IMAGE">
<parameter_description> An image file was broken somehow.
</parameter_description>
</parameter>
<parameter name="GDK_PIXBUF_ERROR_INSUFFICIENT_MEMORY">
<parameter_description> Not enough memory.
</parameter_description>
</parameter>
<parameter name="GDK_PIXBUF_ERROR_BAD_OPTION">
<parameter_description> A bad option was passed to a pixbuf save module.
</parameter_description>
</parameter>
<parameter name="GDK_PIXBUF_ERROR_UNKNOWN_TYPE">
<parameter_description> Unknown image type.
</parameter_description>
</parameter>
<parameter name="GDK_PIXBUF_ERROR_UNSUPPORTED_OPERATION">
<parameter_description> Don't know how to perform the
given operation on the type of image at hand.
</parameter_description>
</parameter>
<parameter name="GDK_PIXBUF_ERROR_FAILED">
<parameter_description> Generic failure code, something went wrong.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkPixbufFormatFlags">
<description>
Flags which allow a module to specify further details about the supported
operations.

Since: 2.2

</description>
<parameters>
<parameter name="GDK_PIXBUF_FORMAT_WRITABLE">
<parameter_description> the module can write out images in the format.
</parameter_description>
</parameter>
<parameter name="GDK_PIXBUF_FORMAT_SCALABLE">
<parameter_description> the image format is scalable
</parameter_description>
</parameter>
<parameter name="GDK_PIXBUF_FORMAT_THREADSAFE">
<parameter_description> the module is threadsafe. &amp;gdk-pixbuf;
ignores modules that are not marked as threadsafe. (Since 2.28).
</parameter_description>
</parameter>
</parameters>
</enum>

<signal name="GdkPixbufLoader::area-prepared">
<description>
This signal is emitted when the pixbuf loader has allocated the 
pixbuf in the desired size.  After this signal is emitted, 
applications can call gdk_pixbuf_loader_get_pixbuf() to fetch 
the partially-loaded pixbuf.

</description>
<parameters>
<parameter name="loader">
<parameter_description> the object which received the signal.
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<signal name="GdkPixbufLoader::area-updated">
<description>
This signal is emitted when a significant area of the image being
loaded has been updated.  Normally it means that a complete
scanline has been read in, but it could be a different area as
well.  Applications can use this signal to know when to repaint
areas of an image that is being loaded.

</description>
<parameters>
<parameter name="loader">
<parameter_description> the object which received the signal.
</parameter_description>
</parameter>
<parameter name="x">
<parameter_description> X offset of upper-left corner of the updated area.
</parameter_description>
</parameter>
<parameter name="y">
<parameter_description> Y offset of upper-left corner of the updated area.
</parameter_description>
</parameter>
<parameter name="width">
<parameter_description> Width of updated area.
</parameter_description>
</parameter>
<parameter name="height">
<parameter_description> Height of updated area.
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<signal name="GdkPixbufLoader::closed">
<description>
This signal is emitted when gdk_pixbuf_loader_close() is called.
It can be used by different parts of an application to receive
notification when an image loader is closed by the code that
drives it.

</description>
<parameters>
<parameter name="loader">
<parameter_description> the object which received the signal.
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<signal name="GdkPixbufLoader::size-prepared">
<description>
This signal is emitted when the pixbuf loader has been fed the
initial amount of data that is required to figure out the size
of the image that it will create.  Applications can call  
gdk_pixbuf_loader_set_size() in response to this signal to set
the desired size to which the image should be scaled.

</description>
<parameters>
<parameter name="loader">
<parameter_description> the object which received the signal.
</parameter_description>
</parameter>
<parameter name="width">
<parameter_description> the original width of the image
</parameter_description>
</parameter>
<parameter name="height">
<parameter_description> the original height of the image
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<enum name="GdkPixbufRotation">
<description>
The possible rotations which can be passed to gdk_pixbuf_rotate_simple().
To make them easier to use, their numerical values are the actual degrees.

</description>
<parameters>
<parameter name="GDK_PIXBUF_ROTATE_NONE">
<parameter_description> No rotation.
</parameter_description>
</parameter>
<parameter name="GDK_PIXBUF_ROTATE_COUNTERCLOCKWISE">
<parameter_description> Rotate by 90 degrees.
</parameter_description>
</parameter>
<parameter name="GDK_PIXBUF_ROTATE_UPSIDEDOWN">
<parameter_description> Rotate by 180 degrees.
</parameter_description>
</parameter>
<parameter name="GDK_PIXBUF_ROTATE_CLOCKWISE">
<parameter_description> Rotate by 270 degrees.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkPixdataDumpType">
<description>
An enumeration which is used by gdk_pixdata_to_csource() to
determine the form of C source to be generated. The three values
@GDK_PIXDATA_DUMP_PIXDATA_STREAM, @GDK_PIXDATA_DUMP_PIXDATA_STRUCT
and @GDK_PIXDATA_DUMP_MACROS are mutually exclusive, as are
@GDK_PIXBUF_DUMP_GTYPES and @GDK_PIXBUF_DUMP_CTYPES. The remaining
elements are optional flags that can be freely added. 

</description>
<parameters>
<parameter name="GDK_PIXDATA_DUMP_PIXDATA_STREAM">
<parameter_description> Generate pixbuf data stream (a single 
string containing a serialized #GdkPixdata structure in network byte 
order).
</parameter_description>
</parameter>
<parameter name="GDK_PIXDATA_DUMP_PIXDATA_STRUCT">
<parameter_description> Generate #GdkPixdata structure (needs 
the #GdkPixdata structure definition from gdk-pixdata.h).
</parameter_description>
</parameter>
<parameter name="GDK_PIXDATA_DUMP_MACROS">
<parameter_description> Generate &lt;function&gt;*_ROWSTRIDE&lt;/function&gt;,     
&lt;function&gt;*_WIDTH&lt;/function&gt;, &lt;function&gt;*_HEIGHT&lt;/function&gt;,
&lt;function&gt;*_BYTES_PER_PIXEL&lt;/function&gt; and 
&lt;function&gt;*_RLE_PIXEL_DATA&lt;/function&gt; or &lt;function&gt;*_PIXEL_DATA&lt;/function&gt;
macro definitions for the image.
</parameter_description>
</parameter>
<parameter name="GDK_PIXDATA_DUMP_GTYPES">
<parameter_description> Generate GLib data types instead of 
standard C data types.
</parameter_description>
</parameter>
<parameter name="GDK_PIXDATA_DUMP_CTYPES">
<parameter_description> Generate standard C data types instead of 
GLib data types.
</parameter_description>
</parameter>
<parameter name="GDK_PIXDATA_DUMP_STATIC">
<parameter_description> Generate static symbols.
</parameter_description>
</parameter>
<parameter name="GDK_PIXDATA_DUMP_CONST">
<parameter_description> Generate const symbols.
</parameter_description>
</parameter>
<parameter name="GDK_PIXDATA_DUMP_RLE_DECODER">
<parameter_description> Provide a &lt;function&gt;*_RUN_LENGTH_DECODE(image_buf, rle_data, size, bpp)&lt;/function&gt; 
macro definition  to  decode  run-length encoded image data.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkPixdataType">
<description>
An enumeration containing three sets of flags for a #GdkPixdata struct: 
one for the used colorspace, one for the width of the samples and one 
for the encoding of the pixel data.  

</description>
<parameters>
<parameter name="GDK_PIXDATA_COLOR_TYPE_RGB">
<parameter_description>  each pixel has red, green and blue samples.
</parameter_description>
</parameter>
<parameter name="GDK_PIXDATA_COLOR_TYPE_RGBA">
<parameter_description> each pixel has red, green and blue samples 
and an alpha value.
</parameter_description>
</parameter>
<parameter name="GDK_PIXDATA_COLOR_TYPE_MASK">
<parameter_description> mask for the colortype flags of the enum.
</parameter_description>
</parameter>
<parameter name="GDK_PIXDATA_SAMPLE_WIDTH_8">
<parameter_description> each sample has 8 bits.
</parameter_description>
</parameter>
<parameter name="GDK_PIXDATA_SAMPLE_WIDTH_MASK">
<parameter_description> mask for the sample width flags of the enum.
</parameter_description>
</parameter>
<parameter name="GDK_PIXDATA_ENCODING_RAW">
<parameter_description> the pixel data is in raw form. 
</parameter_description>
</parameter>
<parameter name="GDK_PIXDATA_ENCODING_RLE">
<parameter_description> the pixel data is run-length encoded. Runs may 
be up to 127 bytes long; their length is stored in a single byte 
preceding the pixel data for the run. If a run is constant, its length
byte has the high bit set and the pixel data consists of a single pixel
which must be repeated. 
</parameter_description>
</parameter>
<parameter name="GDK_PIXDATA_ENCODING_MASK">
<parameter_description> mask for the encoding flags of the enum.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkPropMode">
<description>
Describes how existing data is combined with new data when
using gdk_property_change().

</description>
<parameters>
<parameter name="GDK_PROP_MODE_REPLACE">
<parameter_description> the new data replaces the existing data.
</parameter_description>
</parameter>
<parameter name="GDK_PROP_MODE_PREPEND">
<parameter_description> the new data is prepended to the existing data.
</parameter_description>
</parameter>
<parameter name="GDK_PROP_MODE_APPEND">
<parameter_description> the new data is appended to the existing data.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkPropertyState">
<description>
Specifies the type of a property change for a #GdkEventProperty.

</description>
<parameters>
<parameter name="GDK_PROPERTY_NEW_VALUE">
<parameter_description> the property value was changed.
</parameter_description>
</parameter>
<parameter name="GDK_PROPERTY_DELETE">
<parameter_description> the property was deleted.
</parameter_description>
</parameter>
</parameters>
</enum>

<signal name="GdkScreen::composited-changed">
<description>
The ::composited-changed signal is emitted when the composited
status of the screen changes

Since: 2.10

</description>
<parameters>
<parameter name="screen">
<parameter_description> the object on which the signal is emitted
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<signal name="GdkScreen::monitors-changed">
<description>
The ::monitors-changed signal is emitted when the number, size
or position of the monitors attached to the screen change. 

Only for X11 and OS X for now. A future implementation for Win32
may be a possibility.

Since: 2.14

</description>
<parameters>
<parameter name="screen">
<parameter_description> the object on which the signal is emitted
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<signal name="GdkScreen::size-changed">
<description>
The ::size-changed signal is emitted when the pixel width or 
height of a screen changes.

Since: 2.2

</description>
<parameters>
<parameter name="screen">
<parameter_description> the object on which the signal is emitted
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<enum name="GdkScrollDirection">
<description>
Specifies the direction for #GdkEventScroll.

</description>
<parameters>
<parameter name="GDK_SCROLL_UP">
<parameter_description> the window is scrolled up.
</parameter_description>
</parameter>
<parameter name="GDK_SCROLL_DOWN">
<parameter_description> the window is scrolled down.
</parameter_description>
</parameter>
<parameter name="GDK_SCROLL_LEFT">
<parameter_description> the window is scrolled to the left.
</parameter_description>
</parameter>
<parameter name="GDK_SCROLL_RIGHT">
<parameter_description> the window is scrolled to the right.
</parameter_description>
</parameter>
<parameter name="GDK_SCROLL_SMOOTH">
<parameter_description> the scrolling is determined by the delta values
in #GdkEventScroll. See gdk_event_get_scroll_deltas(). Since: 3.4
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkSettingAction">
<description>
Specifies the kind of modification applied to a setting in a
#GdkEventSetting.

</description>
<parameters>
<parameter name="GDK_SETTING_ACTION_NEW">
<parameter_description> a setting was added.
</parameter_description>
</parameter>
<parameter name="GDK_SETTING_ACTION_CHANGED">
<parameter_description> a setting was changed.
</parameter_description>
</parameter>
<parameter name="GDK_SETTING_ACTION_DELETED">
<parameter_description> a setting was deleted.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkVisibilityState">
<description>
Specifies the visiblity status of a window for a #GdkEventVisibility.

</description>
<parameters>
<parameter name="GDK_VISIBILITY_UNOBSCURED">
<parameter_description> the window is completely visible.
</parameter_description>
</parameter>
<parameter name="GDK_VISIBILITY_PARTIAL">
<parameter_description> the window is partially visible.
</parameter_description>
</parameter>
<parameter name="GDK_VISIBILITY_FULLY_OBSCURED">
<parameter_description> the window is not visible at all.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkVisualType">
<description>
A set of values that describe the manner in which the pixel values
for a visual are converted into RGB values for display.

</description>
<parameters>
<parameter name="GDK_VISUAL_STATIC_GRAY">
<parameter_description> Each pixel value indexes a grayscale value
directly.
</parameter_description>
</parameter>
<parameter name="GDK_VISUAL_GRAYSCALE">
<parameter_description> Each pixel is an index into a color map that
maps pixel values into grayscale values. The color map can be
changed by an application.
</parameter_description>
</parameter>
<parameter name="GDK_VISUAL_STATIC_COLOR">
<parameter_description> Each pixel value is an index into a predefined,
unmodifiable color map that maps pixel values into RGB values.
</parameter_description>
</parameter>
<parameter name="GDK_VISUAL_PSEUDO_COLOR">
<parameter_description> Each pixel is an index into a color map that
maps pixel values into rgb values. The color map can be changed by
an application.
</parameter_description>
</parameter>
<parameter name="GDK_VISUAL_TRUE_COLOR">
<parameter_description> Each pixel value directly contains red, green,
and blue components. Use gdk_visual_get_red_pixel_details(), etc,
to obtain information about how the components are assembled into
a pixel value.
</parameter_description>
</parameter>
<parameter name="GDK_VISUAL_DIRECT_COLOR">
<parameter_description> Each pixel value contains red, green, and blue
components as for %GDK_VISUAL_TRUE_COLOR, but the components are
mapped via a color table into the final output table instead of
being converted directly.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkWMDecoration">
<description>
These are hints originally defined by the Motif toolkit.
The window manager can use them when determining how to decorate
the window. The hint must be set before mapping the window.

</description>
<parameters>
<parameter name="GDK_DECOR_ALL">
<parameter_description> all decorations should be applied.
</parameter_description>
</parameter>
<parameter name="GDK_DECOR_BORDER">
<parameter_description> a frame should be drawn around the window.
</parameter_description>
</parameter>
<parameter name="GDK_DECOR_RESIZEH">
<parameter_description> the frame should have resize handles.
</parameter_description>
</parameter>
<parameter name="GDK_DECOR_TITLE">
<parameter_description> a titlebar should be placed above the window.
</parameter_description>
</parameter>
<parameter name="GDK_DECOR_MENU">
<parameter_description> a button for opening a menu should be included.
</parameter_description>
</parameter>
<parameter name="GDK_DECOR_MINIMIZE">
<parameter_description> a minimize button should be included.
</parameter_description>
</parameter>
<parameter name="GDK_DECOR_MAXIMIZE">
<parameter_description> a maximize button should be included.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkWMFunction">
<description>
These are hints originally defined by the Motif toolkit. The window manager
can use them when determining the functions to offer for the window. The
hint must be set before mapping the window.

</description>
<parameters>
<parameter name="GDK_FUNC_ALL">
<parameter_description> all functions should be offered.
</parameter_description>
</parameter>
<parameter name="GDK_FUNC_RESIZE">
<parameter_description> the window should be resizable.
</parameter_description>
</parameter>
<parameter name="GDK_FUNC_MOVE">
<parameter_description> the window should be movable.
</parameter_description>
</parameter>
<parameter name="GDK_FUNC_MINIMIZE">
<parameter_description> the window should be minimizable.
</parameter_description>
</parameter>
<parameter name="GDK_FUNC_MAXIMIZE">
<parameter_description> the window should be maximizable.
</parameter_description>
</parameter>
<parameter name="GDK_FUNC_CLOSE">
<parameter_description> the window should be closable.
</parameter_description>
</parameter>
</parameters>
</enum>

<signal name="GdkWindow::create-surface">
<description>
The ::create-surface signal is emitted when an offscreen window
needs its surface (re)created, which happens either when the the
window is first drawn to, or when the window is being
resized. The first signal handler that returns a non-%NULL
surface will stop any further signal emission, and its surface
will be used.

Note that it is not possible to access the window's previous
surface from within any callback of this signal. Calling
gdk_offscreen_window_get_surface() will lead to a crash.

Since: 3.0

</description>
<parameters>
<parameter name="window">
<parameter_description> the offscreen window on which the signal is emitted
</parameter_description>
</parameter>
<parameter name="width">
<parameter_description> the width of the offscreen surface to create
</parameter_description>
</parameter>
<parameter name="height">
<parameter_description> the height of the offscreen surface to create
</parameter_description>
</parameter>
</parameters>
<return> the newly created #cairo_surface_t for the offscreen window

</return>
</signal>

<signal name="GdkWindow::from-embedder">
<description>
The ::from-embedder signal is emitted to translate coordinates
in the embedder of an offscreen window to the offscreen window.

See also #GtkWindow::to-embedder.

Since: 2.18

</description>
<parameters>
<parameter name="window">
<parameter_description> the offscreen window on which the signal is emitted
</parameter_description>
</parameter>
<parameter name="embedder_x">
<parameter_description> x coordinate in the embedder window
</parameter_description>
</parameter>
<parameter name="embedder_y">
<parameter_description> y coordinate in the embedder window
</parameter_description>
</parameter>
<parameter name="offscreen_x">
<parameter_description> return location for the x
coordinate in the offscreen window
</parameter_description>
</parameter>
<parameter name="offscreen_y">
<parameter_description> return location for the y
coordinate in the offscreen window
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<signal name="GdkWindow::pick-embedded-child">
<description>
The ::pick-embedded-child signal is emitted to find an embedded
child at the given position.

Since: 2.18

</description>
<parameters>
<parameter name="window">
<parameter_description> the window on which the signal is emitted
</parameter_description>
</parameter>
<parameter name="x">
<parameter_description> x coordinate in the window
</parameter_description>
</parameter>
<parameter name="y">
<parameter_description> y coordinate in the window
</parameter_description>
</parameter>
</parameters>
<return> the #GdkWindow of the embedded child at
@x, @y, or %NULL

</return>
</signal>

<signal name="GdkWindow::to-embedder">
<description>
The ::to-embedder signal is emitted to translate coordinates
in an offscreen window to its embedder.

See also #GtkWindow::from-embedder.

Since: 2.18

</description>
<parameters>
<parameter name="window">
<parameter_description> the offscreen window on which the signal is emitted
</parameter_description>
</parameter>
<parameter name="offscreen_x">
<parameter_description> x coordinate in the offscreen window
</parameter_description>
</parameter>
<parameter name="offscreen_y">
<parameter_description> y coordinate in the offscreen window
</parameter_description>
</parameter>
<parameter name="embedder_x">
<parameter_description> return location for the x
coordinate in the embedder window
</parameter_description>
</parameter>
<parameter name="embedder_y">
<parameter_description> return location for the y
coordinate in the embedder window
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>

<enum name="GdkWindowAttributesType">
<description>
Used to indicate which fields in the #GdkWindowAttr struct should be honored.
For example, if you filled in the &quot;cursor&quot; and &quot;x&quot; fields of #GdkWindowAttr,
pass &quot;@GDK_WA_X | @GDK_WA_CURSOR&quot; to gdk_window_new(). Fields in
#GdkWindowAttr not covered by a bit in this enum are required; for example,
the @width/@height, @wclass, and @window_type fields are required, they have
no corresponding flag in #GdkWindowAttributesType.

</description>
<parameters>
<parameter name="GDK_WA_TITLE">
<parameter_description> Honor the title field
</parameter_description>
</parameter>
<parameter name="GDK_WA_X">
<parameter_description> Honor the X coordinate field
</parameter_description>
</parameter>
<parameter name="GDK_WA_Y">
<parameter_description> Honor the Y coordinate field
</parameter_description>
</parameter>
<parameter name="GDK_WA_CURSOR">
<parameter_description> Honor the cursor field
</parameter_description>
</parameter>
<parameter name="GDK_WA_VISUAL">
<parameter_description> Honor the visual field
</parameter_description>
</parameter>
<parameter name="GDK_WA_WMCLASS">
<parameter_description> Honor the wmclass_class and wmclass_name fields
</parameter_description>
</parameter>
<parameter name="GDK_WA_NOREDIR">
<parameter_description> Honor the override_redirect field
</parameter_description>
</parameter>
<parameter name="GDK_WA_TYPE_HINT">
<parameter_description> Honor the type_hint field
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkWindowEdge">
<description>
Determines a window edge or corner.

</description>
<parameters>
<parameter name="GDK_WINDOW_EDGE_NORTH_WEST">
<parameter_description> the top left corner.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_EDGE_NORTH">
<parameter_description> the top edge.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_EDGE_NORTH_EAST">
<parameter_description> the top right corner.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_EDGE_WEST">
<parameter_description> the left edge.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_EDGE_EAST">
<parameter_description> the right edge.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_EDGE_SOUTH_WEST">
<parameter_description> the lower left corner.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_EDGE_SOUTH">
<parameter_description> the lower edge.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_EDGE_SOUTH_EAST">
<parameter_description> the lower right corner.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkWindowHints">
<description>
Used to indicate which fields of a #GdkGeometry struct should be paid
attention to. Also, the presence/absence of @GDK_HINT_POS,
@GDK_HINT_USER_POS, and @GDK_HINT_USER_SIZE is significant, though they don't
directly refer to #GdkGeometry fields. @GDK_HINT_USER_POS will be set
automatically by #GtkWindow if you call gtk_window_move().
@GDK_HINT_USER_POS and @GDK_HINT_USER_SIZE should be set if the user
specified a size/position using a --geometry command-line argument;
gtk_window_parse_geometry() automatically sets these flags.

</description>
<parameters>
<parameter name="GDK_HINT_POS">
<parameter_description> indicates that the program has positioned the window
</parameter_description>
</parameter>
<parameter name="GDK_HINT_MIN_SIZE">
<parameter_description> min size fields are set
</parameter_description>
</parameter>
<parameter name="GDK_HINT_MAX_SIZE">
<parameter_description> max size fields are set
</parameter_description>
</parameter>
<parameter name="GDK_HINT_BASE_SIZE">
<parameter_description> base size fields are set
</parameter_description>
</parameter>
<parameter name="GDK_HINT_ASPECT">
<parameter_description> aspect ratio fields are set
</parameter_description>
</parameter>
<parameter name="GDK_HINT_RESIZE_INC">
<parameter_description> resize increment fields are set
</parameter_description>
</parameter>
<parameter name="GDK_HINT_WIN_GRAVITY">
<parameter_description> window gravity field is set
</parameter_description>
</parameter>
<parameter name="GDK_HINT_USER_POS">
<parameter_description> indicates that the window's position was explicitly set
by the user
</parameter_description>
</parameter>
<parameter name="GDK_HINT_USER_SIZE">
<parameter_description> indicates that the window's size was explicitly set by
the user
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkWindowState">
<description>
Specifies the state of a toplevel window.

</description>
<parameters>
<parameter name="GDK_WINDOW_STATE_WITHDRAWN">
<parameter_description> the window is not shown.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_STATE_ICONIFIED">
<parameter_description> the window is minimized.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_STATE_MAXIMIZED">
<parameter_description> the window is maximized.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_STATE_STICKY">
<parameter_description> the window is sticky.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_STATE_FULLSCREEN">
<parameter_description> the window is maximized without
decorations.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_STATE_ABOVE">
<parameter_description> the window is kept above other windows.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_STATE_BELOW">
<parameter_description> the window is kept below other windows.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_STATE_FOCUSED">
<parameter_description> the window is presented as focused (with active decorations).
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkWindowType">
<description>
Describes the kind of window.

</description>
<parameters>
<parameter name="GDK_WINDOW_ROOT">
<parameter_description> root window; this window has no parent, covers the entire
screen, and is created by the window system
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_TOPLEVEL">
<parameter_description> toplevel window (used to implement #GtkWindow)
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_CHILD">
<parameter_description> child window (used to implement e.g. #GtkEntry)
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_TEMP">
<parameter_description> override redirect temporary window (used to implement
#GtkMenu)
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_FOREIGN">
<parameter_description> foreign window (see gdk_window_foreign_new())
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_OFFSCREEN">
<parameter_description> offscreen window (see
&lt;xref linkend=&quot;OFFSCREEN-WINDOWS&quot;/&gt;). Since 2.18
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkWindowTypeHint">
<description>
These are hints for the window manager that indicate what type of function
the window has. The window manager can use this when determining decoration
and behaviour of the window. The hint must be set before mapping the window.

See the
&lt;ulink url=&quot;http://www.freedesktop.org/Standards/wm-spec&quot;&gt;Extended
Window Manager Hints&lt;/ulink&gt; specification for more details about
window types.

</description>
<parameters>
<parameter name="GDK_WINDOW_TYPE_HINT_NORMAL">
<parameter_description> Normal toplevel window.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_TYPE_HINT_DIALOG">
<parameter_description> Dialog window.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_TYPE_HINT_MENU">
<parameter_description> Window used to implement a menu; GTK+ uses
this hint only for torn-off menus, see #GtkTearoffMenuItem.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_TYPE_HINT_TOOLBAR">
<parameter_description> Window used to implement toolbars.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_TYPE_HINT_SPLASHSCREEN">
<parameter_description> Window used to display a splash
screen during application startup.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_TYPE_HINT_UTILITY">
<parameter_description> Utility windows which are not detached
toolbars or dialogs.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_TYPE_HINT_DOCK">
<parameter_description> Used for creating dock or panel windows.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_TYPE_HINT_DESKTOP">
<parameter_description> Used for creating the desktop background
window.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_TYPE_HINT_DROPDOWN_MENU">
<parameter_description> A menu that belongs to a menubar.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_TYPE_HINT_POPUP_MENU">
<parameter_description> A menu that does not belong to a menubar,
e.g. a context menu.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_TYPE_HINT_TOOLTIP">
<parameter_description> A tooltip.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_TYPE_HINT_NOTIFICATION">
<parameter_description> A notification - typically a &quot;bubble&quot;
that belongs to a status icon.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_TYPE_HINT_COMBO">
<parameter_description> A popup from a combo box.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_TYPE_HINT_DND">
<parameter_description> A window that is used to implement a DND cursor.
</parameter_description>
</parameter>
</parameters>
</enum>

<enum name="GdkWindowWindowClass">
<description>
@GDK_INPUT_OUTPUT windows are the standard kind of window you might expect.
Such windows receive events and are also displayed on screen.
@GDK_INPUT_ONLY windows are invisible; they are usually placed above other
windows in order to trap or filter the events. You can't draw on
@GDK_INPUT_ONLY windows.

</description>
<parameters>
<parameter name="GDK_INPUT_OUTPUT">
<parameter_description> window for graphics and events
</parameter_description>
</parameter>
<parameter name="GDK_INPUT_ONLY">
<parameter_description> window for events only
</parameter_description>
</parameter>
</parameters>
</enum>

<function name="gdk_add_option_entries_libgtk_only">
<description>
Appends gdk option entries to the passed in option group. This is
not public API and must not be used by applications.

</description>
<parameters>
<parameter name="group">
<parameter_description> An option group.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_app_launch_context_new">
<description>
Creates a new #GdkAppLaunchContext.

Since: 2.14

Deprecated: 3.0: Use gdk_display_get_app_launch_context() instead

</description>
<parameters>
</parameters>
<return> a new #GdkAppLaunchContext

</return>
</function>

<function name="gdk_app_launch_context_set_desktop">
<description>
Sets the workspace on which applications will be launched when
using this context when running under a window manager that
supports multiple workspaces, as described in the
&lt;ulink url=&quot;http://www.freedesktop.org/Standards/wm-spec&quot;&gt;Extended
Window Manager Hints&lt;/ulink&gt;.

When the workspace is not specified or @desktop is set to -1,
it is up to the window manager to pick one, typically it will
be the current workspace.

Since: 2.14

</description>
<parameters>
<parameter name="context">
<parameter_description> a #GdkAppLaunchContext
</parameter_description>
</parameter>
<parameter name="desktop">
<parameter_description> the number of a workspace, or -1
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_app_launch_context_set_display">
<description>
Sets the display on which applications will be launched when
using this context. See also gdk_app_launch_context_set_screen().

Since: 2.14

Deprecated: 3.0: Use gdk_display_get_app_launch_context() instead

</description>
<parameters>
<parameter name="context">
<parameter_description> a #GdkAppLaunchContext
</parameter_description>
</parameter>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_app_launch_context_set_icon">
<description>
Sets the icon for applications that are launched with this
context.

Window Managers can use this information when displaying startup
notification.

See also gdk_app_launch_context_set_icon_name().

Since: 2.14

</description>
<parameters>
<parameter name="context">
<parameter_description> a #GdkAppLaunchContext
</parameter_description>
</parameter>
<parameter name="icon">
<parameter_description> a #GIcon, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_app_launch_context_set_icon_name">
<description>
Sets the icon for applications that are launched with this context.
The @icon_name will be interpreted in the same way as the Icon field
in desktop files. See also gdk_app_launch_context_set_icon().

If both @icon and @icon_name are set, the @icon_name takes priority.
If neither @icon or @icon_name is set, the icon is taken from either
the file that is passed to launched application or from the #GAppInfo
for the launched application itself.

Since: 2.14

</description>
<parameters>
<parameter name="context">
<parameter_description> a #GdkAppLaunchContext
</parameter_description>
</parameter>
<parameter name="icon_name">
<parameter_description> an icon name, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_app_launch_context_set_screen">
<description>
Sets the screen on which applications will be launched when
using this context. See also gdk_app_launch_context_set_display().

If both @screen and @display are set, the @screen takes priority.
If neither @screen or @display are set, the default screen and
display are used.

Since: 2.14

</description>
<parameters>
<parameter name="context">
<parameter_description> a #GdkAppLaunchContext
</parameter_description>
</parameter>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_app_launch_context_set_timestamp">
<description>
Sets the timestamp of @context. The timestamp should ideally
be taken from the event that triggered the launch.

Window managers can use this information to avoid moving the
focus to the newly launched application when the user is busy
typing in another window. This is also known as 'focus stealing
prevention'.

Since: 2.14

</description>
<parameters>
<parameter name="context">
<parameter_description> a #GdkAppLaunchContext
</parameter_description>
</parameter>
<parameter name="timestamp">
<parameter_description> a timestamp
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_atom_intern">
<description>
Finds or creates an atom corresponding to a given string.


</description>
<parameters>
<parameter name="atom_name">
<parameter_description> a string.
</parameter_description>
</parameter>
<parameter name="only_if_exists">
<parameter_description> if %TRUE, GDK is allowed to not create a new atom, but
just return %GDK_NONE if the requested atom doesn't already
exists. Currently, the flag is ignored, since checking the
existance of an atom is as expensive as creating it.
</parameter_description>
</parameter>
</parameters>
<return> the atom corresponding to @atom_name.
</return>
</function>

<function name="gdk_atom_intern_static_string">
<description>
Finds or creates an atom corresponding to a given string.

Note that this function is identical to gdk_atom_intern() except
that if a new #GdkAtom is created the string itself is used rather
than a copy. This saves memory, but can only be used if the string
will &lt;emphasis&gt;always&lt;/emphasis&gt; exist. It can be used with statically
allocated strings in the main program, but not with statically
allocated memory in dynamically loaded modules, if you expect to
ever unload the module again (e.g. do not use this function in
GTK+ theme engines).

Since: 2.10

</description>
<parameters>
<parameter name="atom_name">
<parameter_description> a static string
</parameter_description>
</parameter>
</parameters>
<return> the atom corresponding to @atom_name

</return>
</function>

<function name="gdk_atom_name">
<description>
Determines the string corresponding to an atom.


</description>
<parameters>
<parameter name="atom">
<parameter_description> a #GdkAtom.
</parameter_description>
</parameter>
</parameters>
<return> a newly-allocated string containing the string
corresponding to @atom. When you are done with the
return value, you should free it using g_free().
</return>
</function>

<function name="gdk_beep">
<description>
Emits a short beep on the default display.

</description>
<parameters>
</parameters>
<return></return>
</function>

<function name="gdk_cairo_create">
<description>
Creates a Cairo context for drawing to @window.

&lt;note&gt;&lt;warning&gt;
Note that calling cairo_reset_clip() on the resulting #cairo_t will
produce undefined results, so avoid it at all costs.
&lt;/warning&gt;&lt;/note&gt;

Since: 2.8

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> A newly created Cairo context. Free with
cairo_destroy() when you are done drawing.

</return>
</function>

<function name="gdk_cairo_get_clip_rectangle">
<description>
This is a convenience function around cairo_clip_extents().
It rounds the clip extents to integer coordinates and returns
a boolean indicating if a clip area exists.


</description>
<parameters>
<parameter name="cr">
<parameter_description> a cairo context
</parameter_description>
</parameter>
<parameter name="rect">
<parameter_description> return location for the clip, or %NULL
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if a clip rectangle exists, %FALSE if all of @cr is
clipped and all drawing can be skipped
</return>
</function>

<function name="gdk_cairo_rectangle">
<description>
Adds the given rectangle to the current path of @cr.

Since: 2.8

</description>
<parameters>
<parameter name="cr">
<parameter_description> a cairo context
</parameter_description>
</parameter>
<parameter name="rectangle">
<parameter_description> a #GdkRectangle
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_cairo_region">
<description>
Adds the given region to the current path of @cr.

Since: 2.8

</description>
<parameters>
<parameter name="cr">
<parameter_description> a cairo context
</parameter_description>
</parameter>
<parameter name="region">
<parameter_description> a #cairo_region_t
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_cairo_region_create_from_surface">
<description>
Creates region that describes covers the area where the given
@surface is more than 50% opaque.

This function takes into account device offsets that might be
set with cairo_surface_set_device_offset().


</description>
<parameters>
<parameter name="surface">
<parameter_description> a cairo surface
</parameter_description>
</parameter>
</parameters>
<return> A #cairo_region_t; must be freed with cairo_region_destroy()
</return>
</function>

<function name="gdk_cairo_set_source_color">
<description>
Sets the specified #GdkColor as the source color of @cr.

Since: 2.8

Deprecated: 3.4: Use gdk_cairo_set_source_rgba() instead

</description>
<parameters>
<parameter name="cr">
<parameter_description> a cairo context
</parameter_description>
</parameter>
<parameter name="color">
<parameter_description> a #GdkColor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_cairo_set_source_pixbuf">
<description>
Sets the given pixbuf as the source pattern for @cr.

The pattern has an extend mode of %CAIRO_EXTEND_NONE and is aligned
so that the origin of @pixbuf is @pixbuf_x, @pixbuf_y.

Since: 2.8

</description>
<parameters>
<parameter name="cr">
<parameter_description> a cairo context
</parameter_description>
</parameter>
<parameter name="pixbuf">
<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
<parameter name="pixbuf_x">
<parameter_description> X coordinate of location to place upper left corner of @pixbuf
</parameter_description>
</parameter>
<parameter name="pixbuf_y">
<parameter_description> Y coordinate of location to place upper left corner of @pixbuf
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_cairo_set_source_rgba">
<description>
Sets the specified #GdkRGBA as the source color of @cr.

Since: 3.0

</description>
<parameters>
<parameter name="cr">
<parameter_description> a cairo context
</parameter_description>
</parameter>
<parameter name="rgba">
<parameter_description> a #GdkRGBA
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_cairo_set_source_window">
<description>
Sets the given window as the source pattern for @cr.

The pattern has an extend mode of %CAIRO_EXTEND_NONE and is aligned
so that the origin of @window is @x, @y. The window contains all its
subwindows when rendering.

Note that the contents of @window are undefined outside of the
visible part of @window, so use this function with care.

Since: 2.24

</description>
<parameters>
<parameter name="cr">
<parameter_description> a cairo context
</parameter_description>
</parameter>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="x">
<parameter_description> X coordinate of location to place upper left corner of @window
</parameter_description>
</parameter>
<parameter name="y">
<parameter_description> Y coordinate of location to place upper left corner of @window
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_color_copy">
<description>
Makes a copy of a color structure.

The result must be freed using gdk_color_free().


</description>
<parameters>
<parameter name="color">
<parameter_description> a #GdkColor
</parameter_description>
</parameter>
</parameters>
<return> a copy of @color
</return>
</function>

<function name="gdk_color_equal">
<description>
Compares two colors.


</description>
<parameters>
<parameter name="colora">
<parameter_description> a #GdkColor
</parameter_description>
</parameter>
<parameter name="colorb">
<parameter_description> another #GdkColor
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the two colors compare equal
</return>
</function>

<function name="gdk_color_free">
<description>
Frees a color structure created with gdk_color_copy().

</description>
<parameters>
<parameter name="color">
<parameter_description> a #GdkColor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_color_hash">
<description>
A hash function suitable for using for a hash
table that stores #GdkColors.


</description>
<parameters>
<parameter name="color">
<parameter_description> a #GdkColor
</parameter_description>
</parameter>
</parameters>
<return> The hash function applied to @color
</return>
</function>

<function name="gdk_color_parse">
<description>
Parses a textual specification of a color and fill in the
&lt;structfield&gt;red&lt;/structfield&gt;, &lt;structfield&gt;green&lt;/structfield&gt;,
and &lt;structfield&gt;blue&lt;/structfield&gt; fields of a #GdkColor
structure.

The string can either one of a large set of standard names
(taken from the X11 &lt;filename&gt;rgb.txt&lt;/filename&gt; file), or
it can be a hex value in the form '&#35;rgb' '&#35;rrggbb'
'&#35;rrrgggbbb' or '&#35;rrrrggggbbbb' where 'r', 'g' and
'b' are hex digits of the red, green, and blue components
of the color, respectively. (White in the four forms is
'&#35;fff', '&#35;ffffff', '&#35;fffffffff' and
'&#35;ffffffffffff').


</description>
<parameters>
<parameter name="spec">
<parameter_description> the string specifying the color
</parameter_description>
</parameter>
<parameter name="color">
<parameter_description> the #GdkColor to fill in
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the parsing succeeded
</return>
</function>

<function name="gdk_color_to_string">
<description>
Returns a textual specification of @color in the hexadecimal form
&lt;literal&gt;&#35;rrrrggggbbbb&lt;/literal&gt;, where &lt;literal&gt;r&lt;/literal&gt;,
&lt;literal&gt;g&lt;/literal&gt; and &lt;literal&gt;b&lt;/literal&gt; are hex digits
representing the red, green and blue components respectively.

The returned string can be parsed by gdk_color_parse().

Since: 2.12

</description>
<parameters>
<parameter name="color">
<parameter_description> a #GdkColor
</parameter_description>
</parameter>
</parameters>
<return> a newly-allocated text string

</return>
</function>

<function name="gdk_cursor_get_cursor_type">
<description>
Returns the cursor type for this cursor.

Since: 2.22

</description>
<parameters>
<parameter name="cursor">
<parameter_description>  a #GdkCursor
</parameter_description>
</parameter>
</parameters>
<return> a #GdkCursorType

</return>
</function>

<function name="gdk_cursor_get_display">
<description>
Returns the display on which the #GdkCursor is defined.

Since: 2.2

</description>
<parameters>
<parameter name="cursor">
<parameter_description> a #GdkCursor.
</parameter_description>
</parameter>
</parameters>
<return> the #GdkDisplay associated to @cursor

</return>
</function>

<function name="gdk_cursor_get_image">
<description>
Returns a #GdkPixbuf with the image used to display the cursor.

Note that depending on the capabilities of the windowing system and 
on the cursor, GDK may not be able to obtain the image data. In this 
case, %NULL is returned.

Since: 2.8

</description>
<parameters>
<parameter name="cursor">
<parameter_description> a #GdkCursor
</parameter_description>
</parameter>
</parameters>
<return> a #GdkPixbuf representing @cursor, or %NULL

</return>
</function>

<function name="gdk_cursor_new">
<description>
Creates a new cursor from the set of builtin cursors for the default display.
See gdk_cursor_new_for_display().

To make the cursor invisible, use %GDK_BLANK_CURSOR.


</description>
<parameters>
<parameter name="cursor_type">
<parameter_description> cursor to create
</parameter_description>
</parameter>
</parameters>
<return> a new #GdkCursor
</return>
</function>

<function name="gdk_cursor_new_for_display">
<description>
Creates a new cursor from the set of builtin cursors.
Some useful ones are:
&lt;itemizedlist&gt;
&lt;listitem&gt;&lt;para&gt;
&lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;right_ptr.png&quot;&gt;&lt;/inlinegraphic&gt; #GDK_RIGHT_PTR (right-facing arrow)
&lt;/para&gt;&lt;/listitem&gt;
&lt;listitem&gt;&lt;para&gt;
&lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;crosshair.png&quot;&gt;&lt;/inlinegraphic&gt; #GDK_CROSSHAIR (crosshair)
&lt;/para&gt;&lt;/listitem&gt;
&lt;listitem&gt;&lt;para&gt;
&lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;xterm.png&quot;&gt;&lt;/inlinegraphic&gt; #GDK_XTERM (I-beam)
&lt;/para&gt;&lt;/listitem&gt;
&lt;listitem&gt;&lt;para&gt;
&lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;watch.png&quot;&gt;&lt;/inlinegraphic&gt; #GDK_WATCH (busy)
&lt;/para&gt;&lt;/listitem&gt;
&lt;listitem&gt;&lt;para&gt;
&lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;fleur.png&quot;&gt;&lt;/inlinegraphic&gt; #GDK_FLEUR (for moving objects)
&lt;/para&gt;&lt;/listitem&gt;
&lt;listitem&gt;&lt;para&gt;
&lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;hand1.png&quot;&gt;&lt;/inlinegraphic&gt; #GDK_HAND1 (a right-pointing hand)
&lt;/para&gt;&lt;/listitem&gt;
&lt;listitem&gt;&lt;para&gt;
&lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;hand2.png&quot;&gt;&lt;/inlinegraphic&gt; #GDK_HAND2 (a left-pointing hand)
&lt;/para&gt;&lt;/listitem&gt;
&lt;listitem&gt;&lt;para&gt;
&lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;left_side.png&quot;&gt;&lt;/inlinegraphic&gt; #GDK_LEFT_SIDE (resize left side)
&lt;/para&gt;&lt;/listitem&gt;
&lt;listitem&gt;&lt;para&gt;
&lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;right_side.png&quot;&gt;&lt;/inlinegraphic&gt; #GDK_RIGHT_SIDE (resize right side)
&lt;/para&gt;&lt;/listitem&gt;
&lt;listitem&gt;&lt;para&gt;
&lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;top_left_corner.png&quot;&gt;&lt;/inlinegraphic&gt; #GDK_TOP_LEFT_CORNER (resize northwest corner)
&lt;/para&gt;&lt;/listitem&gt;
&lt;listitem&gt;&lt;para&gt;
&lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;top_right_corner.png&quot;&gt;&lt;/inlinegraphic&gt; #GDK_TOP_RIGHT_CORNER (resize northeast corner)
&lt;/para&gt;&lt;/listitem&gt;
&lt;listitem&gt;&lt;para&gt;
&lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;bottom_left_corner.png&quot;&gt;&lt;/inlinegraphic&gt; #GDK_BOTTOM_LEFT_CORNER (resize southwest corner)
&lt;/para&gt;&lt;/listitem&gt;
&lt;listitem&gt;&lt;para&gt;
&lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;bottom_right_corner.png&quot;&gt;&lt;/inlinegraphic&gt; #GDK_BOTTOM_RIGHT_CORNER (resize southeast corner)
&lt;/para&gt;&lt;/listitem&gt;
&lt;listitem&gt;&lt;para&gt;
&lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;top_side.png&quot;&gt;&lt;/inlinegraphic&gt; #GDK_TOP_SIDE (resize top side)
&lt;/para&gt;&lt;/listitem&gt;
&lt;listitem&gt;&lt;para&gt;
&lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;bottom_side.png&quot;&gt;&lt;/inlinegraphic&gt; #GDK_BOTTOM_SIDE (resize bottom side)
&lt;/para&gt;&lt;/listitem&gt;
&lt;listitem&gt;&lt;para&gt;
&lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;sb_h_double_arrow.png&quot;&gt;&lt;/inlinegraphic&gt; #GDK_SB_H_DOUBLE_ARROW (move vertical splitter)
&lt;/para&gt;&lt;/listitem&gt;
&lt;listitem&gt;&lt;para&gt;
&lt;inlinegraphic format=&quot;PNG&quot; fileref=&quot;sb_v_double_arrow.png&quot;&gt;&lt;/inlinegraphic&gt; #GDK_SB_V_DOUBLE_ARROW (move horizontal splitter)
&lt;/para&gt;&lt;/listitem&gt;
&lt;listitem&gt;&lt;para&gt;
#GDK_BLANK_CURSOR (Blank cursor). Since 2.16
&lt;/para&gt;&lt;/listitem&gt;
&lt;/itemizedlist&gt;

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description> the #GdkDisplay for which the cursor will be created
</parameter_description>
</parameter>
<parameter name="cursor_type">
<parameter_description> cursor to create
</parameter_description>
</parameter>
</parameters>
<return> a new #GdkCursor

</return>
</function>

<function name="gdk_cursor_new_from_name">
<description>
Creates a new cursor by looking up @name in the current cursor
theme.

Since: 2.8

</description>
<parameters>
<parameter name="display">
<parameter_description> the #GdkDisplay for which the cursor will be created
</parameter_description>
</parameter>
<parameter name="name">
<parameter_description> the name of the cursor
</parameter_description>
</parameter>
</parameters>
<return> a new #GdkCursor, or %NULL if there is no cursor with
the given name

</return>
</function>

<function name="gdk_cursor_new_from_pixbuf">
<description>
Creates a new cursor from a pixbuf.

Not all GDK backends support RGBA cursors. If they are not
supported, a monochrome approximation will be displayed.
The functions gdk_display_supports_cursor_alpha() and
gdk_display_supports_cursor_color() can be used to determine
whether RGBA cursors are supported;
gdk_display_get_default_cursor_size() and
gdk_display_get_maximal_cursor_size() give information about
cursor sizes.

If @x or @y are &lt;literal&gt;-1&lt;/literal&gt;, the pixbuf must have
options named &quot;x_hot&quot; and &quot;y_hot&quot;, resp., containing
integer values between %0 and the width resp. height of
the pixbuf. (Since: 3.0)

On the X backend, support for RGBA cursors requires a
sufficently new version of the X Render extension.

Since: 2.4

</description>
<parameters>
<parameter name="display">
<parameter_description> the #GdkDisplay for which the cursor will be created
</parameter_description>
</parameter>
<parameter name="pixbuf">
<parameter_description> the #GdkPixbuf containing the cursor image
</parameter_description>
</parameter>
<parameter name="x">
<parameter_description> the horizontal offset of the 'hotspot' of the cursor.
</parameter_description>
</parameter>
<parameter name="y">
<parameter_description> the vertical offset of the 'hotspot' of the cursor.
</parameter_description>
</parameter>
</parameters>
<return> a new #GdkCursor.

</return>
</function>

<function name="gdk_cursor_ref">
<description>
Adds a reference to @cursor.

Deprecated: 3.0: Use g_object_ref() instead

</description>
<parameters>
<parameter name="cursor">
<parameter_description> a #GdkCursor
</parameter_description>
</parameter>
</parameters>
<return> Same @cursor that was passed in

</return>
</function>

<function name="gdk_cursor_unref">
<description>
Removes a reference from @cursor, deallocating the cursor
if no references remain.

Deprecated: 3.0: Use g_object_unref() instead

</description>
<parameters>
<parameter name="cursor">
<parameter_description> a #GdkCursor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_device_free_history">
<description>
Frees an array of #GdkTimeCoord that was returned by gdk_device_get_history().

</description>
<parameters>
<parameter name="events">
<parameter_description> an array of #GdkTimeCoord.
</parameter_description>
</parameter>
<parameter name="n_events">
<parameter_description> the length of the array.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_device_get_associated_device">
<description>
Returns the associated device to @device, if @device is of type
%GDK_DEVICE_TYPE_MASTER, it will return the paired pointer or
keyboard.

If @device is of type %GDK_DEVICE_TYPE_SLAVE, it will return
the master device to which @device is attached to.

If @device is of type %GDK_DEVICE_TYPE_FLOATING, %NULL will be
returned, as there is no associated device.

Since: 3.0

</description>
<parameters>
<parameter name="device">
<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
<return> The associated device, or %NULL

</return>
</function>

<function name="gdk_device_get_axis">
<description>
Interprets an array of double as axis values for a given device,
and locates the value in the array for a given axis use.


</description>
<parameters>
<parameter name="device">
<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
<parameter name="axes">
<parameter_description> pointer to an array of axes
</parameter_description>
</parameter>
<parameter name="use">
<parameter_description> the use to look for
</parameter_description>
</parameter>
<parameter name="value">
<parameter_description> location to store the found value.
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the given axis use was found, otherwise %FALSE
</return>
</function>

<function name="gdk_device_get_axis_use">
<description>
Returns the axis use for @index_.

Since: 2.20

</description>
<parameters>
<parameter name="device">
<parameter_description> a pointer #GdkDevice.
</parameter_description>
</parameter>
<parameter name="index_">
<parameter_description> the index of the axis.
</parameter_description>
</parameter>
</parameters>
<return> a #GdkAxisUse specifying how the axis is used.

</return>
</function>

<function name="gdk_device_get_axis_value">
<description>
Interprets an array of double as axis values for a given device,
and locates the value in the array for a given axis label, as returned
by gdk_device_list_axes()

Since: 3.0

</description>
<parameters>
<parameter name="device">
<parameter_description> a pointer #GdkDevice.
</parameter_description>
</parameter>
<parameter name="axes">
<parameter_description> pointer to an array of axes
</parameter_description>
</parameter>
<parameter name="axis_label">
<parameter_description> #GdkAtom with the axis label.
</parameter_description>
</parameter>
<parameter name="value">
<parameter_description> location to store the found value.
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the given axis use was found, otherwise %FALSE.

</return>
</function>

<function name="gdk_device_get_device_type">
<description>
Returns the device type for @device.

Since: 3.0

</description>
<parameters>
<parameter name="device">
<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
<return> the #GdkDeviceType for @device.

</return>
</function>

<function name="gdk_device_get_display">
<description>
Returns the #GdkDisplay to which @device pertains.

Since: 3.0

</description>
<parameters>
<parameter name="device">
<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
<return> a #GdkDisplay. This memory is owned
by GTK+, and must not be freed or unreffed.

</return>
</function>

<function name="gdk_device_get_has_cursor">
<description>
Determines whether the pointer follows device motion.

Since: 2.20

</description>
<parameters>
<parameter name="device">
<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the pointer follows device motion

</return>
</function>

<function name="gdk_device_get_history">
<description>
Obtains the motion history for a pointer device; given a starting and
ending timestamp, return all events in the motion history for
the device in the given range of time. Some windowing systems
do not support motion history, in which case, %FALSE will
be returned. (This is not distinguishable from the case where
motion history is supported and no events were found.)


</description>
<parameters>
<parameter name="device">
<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
<parameter name="window">
<parameter_description> the window with respect to which which the event coordinates will be reported
</parameter_description>
</parameter>
<parameter name="start">
<parameter_description> starting timestamp for range of events to return
</parameter_description>
</parameter>
<parameter name="stop">
<parameter_description> ending timestamp for the range of events to return
</parameter_description>
</parameter>
<parameter name="events">
<parameter_description> location to store a newly-allocated array of #GdkTimeCoord, or %NULL
</parameter_description>
</parameter>
<parameter name="n_events">
<parameter_description> location to store the length of @events, or %NULL
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the windowing system supports motion history and
at least one event was found.
</return>
</function>

<function name="gdk_device_get_key">
<description>
If @index_ has a valid keyval, this function will return %TRUE
and fill in @keyval and @modifiers with the keyval settings.

Since: 2.20

</description>
<parameters>
<parameter name="device">
<parameter_description> a #GdkDevice.
</parameter_description>
</parameter>
<parameter name="index_">
<parameter_description> the index of the macro button to get.
</parameter_description>
</parameter>
<parameter name="keyval">
<parameter_description> return value for the keyval.
</parameter_description>
</parameter>
<parameter name="modifiers">
<parameter_description> return value for modifiers.
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if keyval is set for @index.

</return>
</function>

<function name="gdk_device_get_mode">
<description>
Determines the mode of the device.

Since: 2.20

</description>
<parameters>
<parameter name="device">
<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
<return> a #GdkInputSource

</return>
</function>

<function name="gdk_device_get_n_axes">
<description>
Returns the number of axes the device currently has.

Since: 3.0

</description>
<parameters>
<parameter name="device">
<parameter_description> a pointer #GdkDevice
</parameter_description>
</parameter>
</parameters>
<return> the number of axes.

</return>
</function>

<function name="gdk_device_get_n_keys">
<description>
Returns the number of keys the device currently has.

Since: 2.24

</description>
<parameters>
<parameter name="device">
<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
<return> the number of keys.

</return>
</function>

<function name="gdk_device_get_name">
<description>
Determines the name of the device.

Since: 2.20

</description>
<parameters>
<parameter name="device">
<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
<return> a name

</return>
</function>

<function name="gdk_device_get_position">
<description>
Gets the current location of @device. As a slave device
coordinates are those of its master pointer, This function
may not be called on devices of type %GDK_DEVICE_TYPE_SLAVE,
unless there is an ongoing grab on them, see gdk_device_grab().

Since: 3.0

</description>
<parameters>
<parameter name="device">
<parameter_description> pointer device to query status about.
</parameter_description>
</parameter>
<parameter name="screen">
<parameter_description> location to store the #GdkScreen
the @device is on, or %NULL.
</parameter_description>
</parameter>
<parameter name="x">
<parameter_description> location to store root window X coordinate of @device, or %NULL.
</parameter_description>
</parameter>
<parameter name="y">
<parameter_description> location to store root window Y coordinate of @device, or %NULL.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_device_get_source">
<description>
Determines the type of the device.

Since: 2.20

</description>
<parameters>
<parameter name="device">
<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
<return> a #GdkInputSource

</return>
</function>

<function name="gdk_device_get_state">
<description>
Gets the current state of a pointer device relative to @window. As a slave
device coordinates are those of its master pointer, This
function may not be called on devices of type %GDK_DEVICE_TYPE_SLAVE,
unless there is an ongoing grab on them, see gdk_device_grab().

</description>
<parameters>
<parameter name="device">
<parameter_description> a #GdkDevice.
</parameter_description>
</parameter>
<parameter name="window">
<parameter_description> a #GdkWindow.
</parameter_description>
</parameter>
<parameter name="axes">
<parameter_description> an array of doubles to store the values of the axes of @device in,
or %NULL.
</parameter_description>
</parameter>
<parameter name="mask">
<parameter_description> location to store the modifiers, or %NULL.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_device_get_window_at_position">
<description>
Obtains the window underneath @device, returning the location of the device in @win_x and @win_y. Returns
%NULL if the window tree under @device is not known to GDK (for example, belongs to another application).

As a slave device coordinates are those of its master pointer, This
function may not be called on devices of type %GDK_DEVICE_TYPE_SLAVE,
unless there is an ongoing grab on them, see gdk_device_grab().

Since: 3.0

</description>
<parameters>
<parameter name="device">
<parameter_description> pointer #GdkDevice to query info to.
</parameter_description>
</parameter>
<parameter name="win_x">
<parameter_description> return location for the X coordinate of the device location,
relative to the window origin, or %NULL.
</parameter_description>
</parameter>
<parameter name="win_y">
<parameter_description> return location for the Y coordinate of the device location,
relative to the window origin, or %NULL.
</parameter_description>
</parameter>
</parameters>
<return> the #GdkWindow under the device position, or %NULL.

</return>
</function>

<function name="gdk_device_grab">
<description>
Grabs the device so that all events coming from this device are passed to
this application until the device is ungrabbed with gdk_device_ungrab(),
or the window becomes unviewable. This overrides any previous grab on the device
by this client.

Device grabs are used for operations which need complete control over the
given device events (either pointer or keyboard). For example in GTK+ this
is used for Drag and Drop operations, popup menus and such.

Note that if the event mask of an X window has selected both button press
and button release events, then a button press event will cause an automatic
pointer grab until the button is released. X does this automatically since
most applications expect to receive button press and release events in pairs.
It is equivalent to a pointer grab on the window with @owner_events set to
%TRUE.

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 #GdkEventGrabBroken
events that are emitted when the grab ends unvoluntarily.

Since: 3.0

</description>
<parameters>
<parameter name="device">
<parameter_description> a #GdkDevice. To get the device you can use gtk_get_current_event_device()
or gdk_event_get_device() if the grab is in reaction to an event. Also, you can use
gdk_device_manager_get_client_pointer() but only in code that isn't triggered by a
#GdkEvent and there aren't other means to get a meaningful #GdkDevice to operate on.
</parameter_description>
</parameter>
<parameter name="window">
<parameter_description> the #GdkWindow which will own the grab (the grab window)
</parameter_description>
</parameter>
<parameter name="grab_ownership">
<parameter_description> specifies the grab ownership.
</parameter_description>
</parameter>
<parameter name="owner_events">
<parameter_description> if %FALSE then all device events are reported with respect to
@window and are only reported if selected by @event_mask. If
%TRUE then pointer events for this application are reported
as normal, but pointer events outside this application are
reported with respect to @window and only if selected by
@event_mask. In either mode, unreported events are discarded.
</parameter_description>
</parameter>
<parameter name="event_mask">
<parameter_description> specifies the event mask, which is used in accordance with
@owner_events.
</parameter_description>
</parameter>
<parameter name="cursor">
<parameter_description> the cursor to display while the grab is active if the device is
a pointer. If this is %NULL then the normal cursors are used for
@window and its descendants, and the cursor for @window is used
elsewhere.
</parameter_description>
</parameter>
<parameter name="time_">
<parameter_description> the timestamp of the event which led to this pointer grab. This
usually comes from the #GdkEvent struct, though %GDK_CURRENT_TIME
can be used if the time isn't known.
</parameter_description>
</parameter>
</parameters>
<return> %GDK_GRAB_SUCCESS if the grab was successful.

</return>
</function>

<function name="gdk_device_grab_info_libgtk_only">
<description>
Determines information about the current keyboard grab.
This is not public API and must not be used by applications.


</description>
<parameters>
<parameter name="display">
<parameter_description> the display for which to get the grab information
</parameter_description>
</parameter>
<parameter name="device">
<parameter_description> device to get the grab information from
</parameter_description>
</parameter>
<parameter name="grab_window">
<parameter_description> location to store current grab window
</parameter_description>
</parameter>
<parameter name="owner_events">
<parameter_description> location to store boolean indicating whether
the @owner_events flag to gdk_keyboard_grab() or
gdk_pointer_grab() was %TRUE.
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if this application currently has the
keyboard grabbed.
</return>
</function>

<function name="gdk_device_list_axes">
<description>
Returns a #GList of #GdkAtom&lt;!-- --&gt;s, containing the labels for
the axes that @device currently has.

Since: 3.0

</description>
<parameters>
<parameter name="device">
<parameter_description> a pointer #GdkDevice
</parameter_description>
</parameter>
</parameters>
<return>
A #GList of #GdkAtom&lt;!-- --&gt;s, free with g_list_free().

</return>
</function>

<function name="gdk_device_list_slave_devices">
<description>
If the device if of type %GDK_DEVICE_TYPE_MASTER, it will return
the list of slave devices attached to it, otherwise it will return
%NULL


</description>
<parameters>
<parameter name="device">
<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
<return> the list of
slave devices, or %NULL. The list must be freed with
g_list_free(), the contents of the list are owned by GTK+
and should not be freed.
</return>
</function>

<function name="gdk_device_manager_get_client_pointer">
<description>
Returns the client pointer, that is, the master pointer that acts as the core pointer
for this application. In X11, window managers may change this depending on the interaction
pattern under the presence of several pointers.

You should use this function sheldomly, only in code that isn't triggered by a #GdkEvent
and there aren't other means to get a meaningful #GdkDevice to operate on.

Since: 3.0

</description>
<parameters>
<parameter name="device_manager">
<parameter_description> a #GdkDeviceManager
</parameter_description>
</parameter>
</parameters>
<return> The client pointer. This memory is
owned by GDK and must not be freed or unreferenced.

</return>
</function>

<function name="gdk_device_manager_get_display">
<description>
Gets the #GdkDisplay associated to @device_manager.

Since: 3.0

</description>
<parameters>
<parameter name="device_manager">
<parameter_description> a #GdkDeviceManager
</parameter_description>
</parameter>
</parameters>
<return> the #GdkDisplay to which @device_manager is
associated to, or #NULL. This memory is owned by GDK and
must not be freed or unreferenced.

</return>
</function>

<function name="gdk_device_manager_list_devices">
<description>
Returns the list of devices of type @type currently attached to
@device_manager.

Since: 3.0

</description>
<parameters>
<parameter name="device_manager">
<parameter_description> a #GdkDeviceManager
</parameter_description>
</parameter>
<parameter name="type">
<parameter_description> device type to get.
</parameter_description>
</parameter>
</parameters>
<return> a list of 
#GdkDevice&lt;!-- --&gt;s. The returned list must be
freed with g_list_free (). The list elements are owned by
GTK+ and must not be freed or unreffed.

</return>
</function>

<function name="gdk_device_set_axis_use">
<description>
Specifies how an axis of a device is used.

</description>
<parameters>
<parameter name="device">
<parameter_description> a pointer #GdkDevice
</parameter_description>
</parameter>
<parameter name="index_">
<parameter_description> the index of the axis
</parameter_description>
</parameter>
<parameter name="use">
<parameter_description> specifies how the axis is used
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_device_set_key">
<description>
Specifies the X key event to generate when a macro button of a device
is pressed.

</description>
<parameters>
<parameter name="device">
<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
<parameter name="index_">
<parameter_description> the index of the macro button to set
</parameter_description>
</parameter>
<parameter name="keyval">
<parameter_description> the keyval to generate
</parameter_description>
</parameter>
<parameter name="modifiers">
<parameter_description> the modifiers to set
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_device_set_mode">
<description>
Sets a the mode of an input device. The mode controls if the
device is active and whether the device's range is mapped to the
entire screen or to a single window.


</description>
<parameters>
<parameter name="device">
<parameter_description> a #GdkDevice.
</parameter_description>
</parameter>
<parameter name="mode">
<parameter_description> the input mode.
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the mode was successfully changed.
</return>
</function>

<function name="gdk_device_ungrab">
<description>
Release any grab on @device.

Since: 3.0

</description>
<parameters>
<parameter name="device">
<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
<parameter name="time_">
<parameter_description> a timestap (e.g. %GDK_CURRENT_TIME).
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_device_warp">
<description>
Warps @device in @display to the point @x,@y on
the screen @screen, unless the device is confined
to a window by a grab, in which case it will be moved
as far as allowed by the grab. Warping the pointer
creates events as if the user had moved the mouse
instantaneously to the destination.

Note that the pointer should normally be under the
control of the user. This function was added to cover
some rare use cases like keyboard navigation support
for the color picker in the #GtkColorSelectionDialog.

Since: 3.0

</description>
<parameters>
<parameter name="device">
<parameter_description> the device to warp.
</parameter_description>
</parameter>
<parameter name="screen">
<parameter_description> the screen to warp @device to.
</parameter_description>
</parameter>
<parameter name="x">
<parameter_description> the X coordinate of the destination.
</parameter_description>
</parameter>
<parameter name="y">
<parameter_description> the Y coordinate of the destination.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_disable_multidevice">
<description>
Disables multidevice support in GDK. This call must happen prior
to gdk_display_open(), gtk_init(), gtk_init_with_args() or
gtk_init_check() in order to take effect.

Most common GTK+ applications won't ever need to call this. Only
applications that do mixed GDK/Xlib calls could want to disable
multidevice support if such Xlib code deals with input devices in
any way and doesn't observe the presence of XInput 2.

Since: 3.0

</description>
<parameters>
</parameters>
<return></return>
</function>

<function name="gdk_display_beep">
<description>
Emits a short beep on @display

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_display_close">
<description>
Closes the connection to the windowing system for the given display,
and cleans up associated resources.

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_display_device_is_grabbed">
<description>
Returns %TRUE if there is an ongoing grab on @device for @display.


</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
<parameter name="device">
<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if there is a grab in effect for @device.
</return>
</function>

<function name="gdk_display_flush">
<description>
Flushes any requests queued for the windowing system; this happens automatically
when the main loop blocks waiting for new events, but if your application
is drawing without returning control to the main loop, you may need
to call this function explicitely. A common case where this function
needs to be called is when an application is executing drawing commands
from a thread other than the thread where the main loop is running.

This is most useful for X11. On windowing systems where requests are
handled synchronously, this function will do nothing.

Since: 2.4

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_display_get_app_launch_context">
<description>
Returns a #GdkAppLaunchContext suitable for launching
applications on the given display.

Since: 3.0

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return> a new #GdkAppLaunchContext for @display.
Free with g_object_unref() when done

</return>
</function>

<function name="gdk_display_get_default">
<description>
Gets the default #GdkDisplay. This is a convenience
function for
&lt;literal&gt;gdk_display_manager_get_default_display (gdk_display_manager_get ())&lt;/literal&gt;.

Since: 2.2

</description>
<parameters>
</parameters>
<return> a #GdkDisplay, or %NULL if there is no default
display.

</return>
</function>

<function name="gdk_display_get_default_cursor_size">
<description>
Returns the default size to use for cursors on @display.

Since: 2.4

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return> the default cursor size.

</return>
</function>

<function name="gdk_display_get_default_group">
<description>
Returns the default group leader window for all toplevel windows
on @display. This window is implicitly created by GDK.
See gdk_window_set_group().

Since: 2.4

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return> The default group leader window
for @display

</return>
</function>

<function name="gdk_display_get_default_screen">
<description>
Get the default #GdkScreen for @display.

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return> the default #GdkScreen object for @display

</return>
</function>

<function name="gdk_display_get_device_manager">
<description>
Returns the #GdkDeviceManager associated to @display.

Since: 3.0

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay.
</parameter_description>
</parameter>
</parameters>
<return> A #GdkDeviceManager, or %NULL. This memory is
owned by GDK and must not be freed or unreferenced.

</return>
</function>

<function name="gdk_display_get_event">
<description>
Gets the next #GdkEvent to be processed for @display, fetching events from the
windowing system if necessary.

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return> the next #GdkEvent to be processed, or %NULL if no events
are pending. The returned #GdkEvent should be freed with gdk_event_free().

</return>
</function>

<function name="gdk_display_get_maximal_cursor_size">
<description>
Gets the maximal size to use for cursors on @display.

Since: 2.4

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
<parameter name="width">
<parameter_description> the return location for the maximal cursor width
</parameter_description>
</parameter>
<parameter name="height">
<parameter_description> the return location for the maximal cursor height
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_display_get_n_screens">
<description>
Gets the number of screen managed by the @display.

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return> number of screens.

</return>
</function>

<function name="gdk_display_get_name">
<description>
Gets the name of the display.

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return> a string representing the display name. This string is owned
by GDK and should not be modified or freed.

</return>
</function>

<function name="gdk_display_get_pointer">
<description>
Gets the current location of the pointer and the current modifier
mask for a given display.

Since: 2.2

Deprecated: 3.0: Use gdk_device_get_position() instead.

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
<parameter name="screen">
<parameter_description> location to store the screen that the
cursor is on, or %NULL.
</parameter_description>
</parameter>
<parameter name="x">
<parameter_description> location to store root window X coordinate of pointer, or %NULL.
</parameter_description>
</parameter>
<parameter name="y">
<parameter_description> location to store root window Y coordinate of pointer, or %NULL.
</parameter_description>
</parameter>
<parameter name="mask">
<parameter_description> location to store current modifier mask, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_display_get_screen">
<description>
Returns a screen object for one of the screens of the display.

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
<parameter name="screen_num">
<parameter_description> the screen number
</parameter_description>
</parameter>
</parameters>
<return> the #GdkScreen object

</return>
</function>

<function name="gdk_display_get_window_at_pointer">
<description>
Obtains the window underneath the mouse pointer, returning the location
of the pointer in that window in @win_x, @win_y for @screen. Returns %NULL
if the window under the mouse pointer is not known to GDK (for example, 
belongs to another application).

Since: 2.2

Deprecated: 3.0: Use gdk_device_get_window_at_position() instead.

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
<parameter name="win_x">
<parameter_description> return location for x coordinate of the pointer location relative
to the window origin, or %NULL
</parameter_description>
</parameter>
<parameter name="win_y">
<parameter_description> return location for y coordinate of the pointer location relative
 &amp;    to the window origin, or %NULL
</parameter_description>
</parameter>
</parameters>
<return> the window under the mouse pointer, or %NULL

</return>
</function>

<function name="gdk_display_has_pending">
<description>
Returns whether the display has events that are waiting
to be processed.

Since: 3.0

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if there are events ready to be processed.

</return>
</function>

<function name="gdk_display_is_closed">
<description>
Finds out if the display has been closed.

Since: 2.22

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the display is closed.

</return>
</function>

<function name="gdk_display_keyboard_ungrab">
<description>
Release any keyboard grab

Since: 2.2

Deprecated: 3.0: Use gdk_device_ungrab(), together with gdk_device_grab()
instead.

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay.
</parameter_description>
</parameter>
<parameter name="time_">
<parameter_description> a timestap (e.g #GDK_CURRENT_TIME).
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_display_list_devices">
<description>
Returns the list of available input devices attached to @display.
The list is statically allocated and should not be freed.

Since: 2.2

Deprecated: 3.0: Use gdk_device_manager_list_devices() instead.

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return>
a list of #GdkDevice

</return>
</function>

<function name="gdk_display_manager_get">
<description>
Gets the singleton #GdkDisplayManager object.

When called for the first time, this function consults the
&lt;envar&gt;GDK_BACKEND&lt;/envar&gt; environment variable to find out which
of the supported GDK backends to use (in case GDK has been compiled
with multiple backends).

Since: 2.2

</description>
<parameters>
</parameters>
<return> The global #GdkDisplayManager singleton;
gdk_parse_args(), gdk_init(), or gdk_init_check() must have
been called first.

</return>
</function>

<function name="gdk_display_manager_get_default_display">
<description>
Gets the default #GdkDisplay.

Since: 2.2

</description>
<parameters>
<parameter name="manager">
<parameter_description> a #GdkDisplayManager
</parameter_description>
</parameter>
</parameters>
<return> a #GdkDisplay, or %NULL
if there is no default display.

</return>
</function>

<function name="gdk_display_manager_list_displays">
<description>
List all currently open displays.

Since: 2.2

</description>
<parameters>
<parameter name="manager">
<parameter_description> a #GdkDisplayManager
</parameter_description>
</parameter>
</parameters>
<return> a newly
allocated #GSList of #GdkDisplay objects. Free with g_slist_free()
when you are done with it.

</return>
</function>

<function name="gdk_display_manager_open_display">
<description>
Opens a display.

Since: 3.0

</description>
<parameters>
<parameter name="manager">
<parameter_description> a #GdkDisplayManager
</parameter_description>
</parameter>
<parameter name="name">
<parameter_description> the name of the display to open
</parameter_description>
</parameter>
</parameters>
<return> a #GdkDisplay, or %NULL
if the display could not be opened

</return>
</function>

<function name="gdk_display_manager_set_default_display">
<description>
Sets @display as the default display.

Since: 2.2

</description>
<parameters>
<parameter name="manager">
<parameter_description> a #GdkDisplayManager
</parameter_description>
</parameter>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_display_notify_startup_complete">
<description>
Indicates to the GUI environment that the application has
finished loading, using a given identifier.

GTK+ will call this function automatically for #GtkWindow
with custom startup-notification identifier unless
gtk_window_set_auto_startup_notification() is called to
disable that feature.

Since: 3.0

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
<parameter name="startup_id">
<parameter_description> a startup-notification identifier, for which
notification process should be completed
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_display_open">
<description>
Opens a display.

Since: 2.2

</description>
<parameters>
<parameter name="display_name">
<parameter_description> the name of the display to open
</parameter_description>
</parameter>
</parameters>
<return> a #GdkDisplay, or %NULL
if the display could not be opened

</return>
</function>

<function name="gdk_display_open_default_libgtk_only">
<description>
Opens the default display specified by command line arguments or
environment variables, sets it as the default display, and returns
it.  gdk_parse_args must have been called first. If the default
display has previously been set, simply returns that. An internal
function that should not be used by applications.


</description>
<parameters>
</parameters>
<return> the default display, if it could be
opened, otherwise %NULL.
</return>
</function>

<function name="gdk_display_peek_event">
<description>
Gets a copy of the first #GdkEvent in the @display's event queue, without
removing the event from the queue.  (Note that this function will
not get more events from the windowing system.  It only checks the events
that have already been moved to the GDK event queue.)

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay 
</parameter_description>
</parameter>
</parameters>
<return> a copy of the first #GdkEvent on the event queue, or %NULL 
if no events are in the queue. The returned #GdkEvent should be freed with
gdk_event_free().

</return>
</function>

<function name="gdk_display_pointer_is_grabbed">
<description>
Test if the pointer is grabbed.

Since: 2.2

Deprecated: 3.0: Use gdk_display_device_is_grabbed() instead.

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if an active X pointer grab is in effect

</return>
</function>

<function name="gdk_display_pointer_ungrab">
<description>
Release any pointer grab.

Since: 2.2

Deprecated: 3.0: Use gdk_device_ungrab(), together with gdk_device_grab()
instead.

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay.
</parameter_description>
</parameter>
<parameter name="time_">
<parameter_description> a timestap (e.g. %GDK_CURRENT_TIME).
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_display_put_event">
<description>
Appends a copy of the given event onto the front of the event
queue for @display.

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
<parameter name="event">
<parameter_description> a #GdkEvent.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_display_request_selection_notification">
<description>
Request #GdkEventOwnerChange events for ownership changes
of the selection named by the given atom.

Since: 2.6

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
<parameter name="selection">
<parameter_description> the #GdkAtom naming the selection for which
ownership change notification is requested
</parameter_description>
</parameter>
</parameters>
<return> whether #GdkEventOwnerChange events will
be sent.

</return>
</function>

<function name="gdk_display_set_double_click_distance">
<description>
Sets the double click distance (two clicks within this distance
count as a double click and result in a #GDK_2BUTTON_PRESS event).
See also gdk_display_set_double_click_time().
Applications should &lt;emphasis&gt;not&lt;/emphasis&gt; set this, it is a global 
user-configured setting.

Since: 2.4

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
<parameter name="distance">
<parameter_description> distance in pixels
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_display_set_double_click_time">
<description>
Sets the double click time (two clicks within this time interval
count as a double click and result in a #GDK_2BUTTON_PRESS event).
Applications should &lt;emphasis&gt;not&lt;/emphasis&gt; set this, it is a global 
user-configured setting.

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
<parameter name="msec">
<parameter_description> double click time in milliseconds (thousandths of a second) 
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_display_store_clipboard">
<description>
Issues a request to the clipboard manager to store the
clipboard data. On X11, this is a special program that works
according to the freedesktop clipboard specification, available at
&lt;ulink url=&quot;http://www.freedesktop.org/Standards/clipboard-manager-spec&quot;&gt;
http://www.freedesktop.org/Standards/clipboard-manager-spec&lt;/ulink&gt;.

Since: 2.6

</description>
<parameters>
<parameter name="display">
<parameter_description>          a #GdkDisplay
</parameter_description>
</parameter>
<parameter name="clipboard_window">
<parameter_description> a #GdkWindow belonging to the clipboard owner
</parameter_description>
</parameter>
<parameter name="time_">
<parameter_description>            a timestamp
</parameter_description>
</parameter>
<parameter name="targets">
<parameter_description> an array of targets
that should be saved, or %NULL
if all available targets should be saved.
</parameter_description>
</parameter>
<parameter name="n_targets">
<parameter_description>        length of the @targets array
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_display_supports_clipboard_persistence">
<description>
Returns whether the speicifed display supports clipboard
persistance; i.e. if it's possible to store the clipboard data after an
application has quit. On X11 this checks if a clipboard daemon is
running.

Since: 2.6

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the display supports clipboard persistance.

</return>
</function>

<function name="gdk_display_supports_composite">
<description>
Returns %TRUE if gdk_window_set_composited() can be used
to redirect drawing on the window using compositing.

Currently this only works on X11 with XComposite and
XDamage extensions available.

Since: 2.12

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if windows may be composited.

</return>
</function>

<function name="gdk_display_supports_cursor_alpha">
<description>
Returns %TRUE if cursors can use an 8bit alpha channel
on @display. Otherwise, cursors are restricted to bilevel
alpha (i.e. a mask).

Since: 2.4

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return> whether cursors can have alpha channels.

</return>
</function>

<function name="gdk_display_supports_cursor_color">
<description>
Returns %TRUE if multicolored cursors are supported
on @display. Otherwise, cursors have only a forground
and a background color.

Since: 2.4

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return> whether cursors can have multiple colors.

</return>
</function>

<function name="gdk_display_supports_input_shapes">
<description>
Returns %TRUE if gdk_window_input_shape_combine_mask() can
be used to modify the input shape of windows on @display.

Since: 2.10

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if windows with modified input shape are supported

</return>
</function>

<function name="gdk_display_supports_selection_notification">
<description>
Returns whether #GdkEventOwnerChange events will be
sent when the owner of a selection changes.

Since: 2.6

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return> whether #GdkEventOwnerChange events will
be sent.

</return>
</function>

<function name="gdk_display_supports_shapes">
<description>
Returns %TRUE if gdk_window_shape_combine_mask() can
be used to create shaped windows on @display.

Since: 2.10

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if shaped windows are supported

</return>
</function>

<function name="gdk_display_sync">
<description>
Flushes any requests queued for the windowing system and waits until all
requests have been handled. This is often used for making sure that the
display is synchronized with the current state of the program. Calling
gdk_display_sync() before gdk_error_trap_pop() makes sure that any errors
generated from earlier requests are handled before the error trap is
removed.

This is most useful for X11. On windowing systems where requests are
handled synchronously, this function will do nothing.

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_display_warp_pointer">
<description>
Warps the pointer of @display to the point @x,@y on
the screen @screen, unless the pointer is confined
to a window by a grab, in which case it will be moved
as far as allowed by the grab. Warping the pointer
creates events as if the user had moved the mouse
instantaneously to the destination.

Note that the pointer should normally be under the
control of the user. This function was added to cover
some rare use cases like keyboard navigation support
for the color picker in the #GtkColorSelectionDialog.

Since: 2.8

Deprecated: 3.0: Use gdk_device_warp() instead.

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
<parameter name="screen">
<parameter_description> the screen of @display to warp the pointer to
</parameter_description>
</parameter>
<parameter name="x">
<parameter_description> the x coordinate of the destination
</parameter_description>
</parameter>
<parameter name="y">
<parameter_description> the y coordinate of the destination
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_drag_abort">
<description>
Aborts a drag without dropping.

This function is called by the drag source.

</description>
<parameters>
<parameter name="context">
<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
<parameter name="time_">
<parameter_description> the timestamp for this operation
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_drag_begin">
<description>
Starts a drag and creates a new drag context for it.
This function assumes that the drag is controlled by the
client pointer device, use gdk_drag_begin_for_device() to
begin a drag with a different device.

This function is called by the drag source.


</description>
<parameters>
<parameter name="window">
<parameter_description> the source window for this drag.
</parameter_description>
</parameter>
<parameter name="targets">
<parameter_description> the offered targets,
as list of #GdkAtoms
</parameter_description>
</parameter>
</parameters>
<return> a newly created #GdkDragContext
</return>
</function>

<function name="gdk_drag_begin_for_device">
<description>
Starts a drag and creates a new drag context for it.

This function is called by the drag source.


</description>
<parameters>
<parameter name="window">
<parameter_description> the source window for this drag
</parameter_description>
</parameter>
<parameter name="device">
<parameter_description> the device that controls this drag
</parameter_description>
</parameter>
<parameter name="targets">
<parameter_description> the offered targets,
as list of #GdkAtoms
</parameter_description>
</parameter>
</parameters>
<return> a newly created #GdkDragContext
</return>
</function>

<function name="gdk_drag_context_get_actions">
<description>
Determines the bitmask of actions proposed by the source if
gdk_drag_context_get_suggested_action() returns GDK_ACTION_ASK.

Since: 2.22

</description>
<parameters>
<parameter name="context">
<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
</parameters>
<return> the #GdkDragAction flags

</return>
</function>

<function name="gdk_drag_context_get_dest_window">
<description>
Returns the destination windw for the DND operation.

Since: 3.0

</description>
<parameters>
<parameter name="context">
<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
</parameters>
<return> a #GdkWindow

</return>
</function>

<function name="gdk_drag_context_get_device">
<description>
Returns the #GdkDevice associated to the drag context.


</description>
<parameters>
<parameter name="context">
<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
</parameters>
<return> The #GdkDevice associated to @context.
</return>
</function>

<function name="gdk_drag_context_get_protocol">
<description>
Returns the drag protocol thats used by this context.

Since: 3.0

</description>
<parameters>
<parameter name="context">
<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
</parameters>
<return> the drag protocol

</return>
</function>

<function name="gdk_drag_context_get_selected_action">
<description>
Determines the action chosen by the drag destination.

Since: 2.22

</description>
<parameters>
<parameter name="context">
<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
</parameters>
<return> a #GdkDragAction value

</return>
</function>

<function name="gdk_drag_context_get_source_window">
<description>
Returns the #GdkWindow where the DND operation started.

Since: 2.22

</description>
<parameters>
<parameter name="context">
<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
</parameters>
<return> a #GdkWindow

</return>
</function>

<function name="gdk_drag_context_get_suggested_action">
<description>
Determines the suggested drag action of the context.

Since: 2.22

</description>
<parameters>
<parameter name="context">
<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
</parameters>
<return> a #GdkDragAction value

</return>
</function>

<function name="gdk_drag_context_list_targets">
<description>
Retrieves the list of targets of the context.

Since: 2.22

</description>
<parameters>
<parameter name="context">
<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
</parameters>
<return> a #GList of targets

</return>
</function>

<function name="gdk_drag_context_set_device">
<description>
Associates a #GdkDevice to @context, so all Drag and Drop events
for @context are emitted as if they came from this device.

</description>
<parameters>
<parameter name="context">
<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
<parameter name="device">
<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_drag_drop">
<description>
Drops on the current destination.

This function is called by the drag source.

</description>
<parameters>
<parameter name="context">
<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
<parameter name="time_">
<parameter_description> the timestamp for this operation
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_drag_drop_succeeded">
<description>
Returns whether the dropped data has been successfully
transferred. This function is intended to be used while
handling a %GDK_DROP_FINISHED event, its return value is
meaningless at other times.

Since: 2.6

</description>
<parameters>
<parameter name="context">
<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the drop was successful.

</return>
</function>

<function name="gdk_drag_find_window_for_screen">
<description>
Finds the destination window and DND protocol to use at the
given pointer position.

This function is called by the drag source to obtain the
@dest_window and @protocol parameters for gdk_drag_motion().

Since: 2.2

</description>
<parameters>
<parameter name="context">
<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
<parameter name="drag_window">
<parameter_description> a window which may be at the pointer position, but
should be ignored, since it is put up by the drag source as an icon
</parameter_description>
</parameter>
<parameter name="screen">
<parameter_description> the screen where the destination window is sought
</parameter_description>
</parameter>
<parameter name="x_root">
<parameter_description> the x position of the pointer in root coordinates
</parameter_description>
</parameter>
<parameter name="y_root">
<parameter_description> the y position of the pointer in root coordinates
</parameter_description>
</parameter>
<parameter name="dest_window">
<parameter_description> location to store the destination window in
</parameter_description>
</parameter>
<parameter name="protocol">
<parameter_description> location to store the DND protocol in
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_drag_get_selection">
<description>
Returns the selection atom for the current source window.


</description>
<parameters>
<parameter name="context">
<parameter_description> a #GdkDragContext.
</parameter_description>
</parameter>
</parameters>
<return> the selection atom, or %GDK_NONE
</return>
</function>

<function name="gdk_drag_motion">
<description>
Updates the drag context when the pointer moves or the
set of actions changes.

This function is called by the drag source.

</description>
<parameters>
<parameter name="context">
<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
<parameter name="dest_window">
<parameter_description> the new destination window, obtained by
gdk_drag_find_window()
</parameter_description>
</parameter>
<parameter name="protocol">
<parameter_description> the DND protocol in use, obtained by gdk_drag_find_window()
</parameter_description>
</parameter>
<parameter name="x_root">
<parameter_description> the x position of the pointer in root coordinates
</parameter_description>
</parameter>
<parameter name="y_root">
<parameter_description> the y position of the pointer in root coordinates
</parameter_description>
</parameter>
<parameter name="suggested_action">
<parameter_description> the suggested action
</parameter_description>
</parameter>
<parameter name="possible_actions">
<parameter_description> the possible actions
</parameter_description>
</parameter>
<parameter name="time_">
<parameter_description> the timestamp for this operation
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_drag_status">
<description>
Selects one of the actions offered by the drag source.

This function is called by the drag destination in response to
gdk_drag_motion() called by the drag source.

</description>
<parameters>
<parameter name="context">
<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
<parameter name="action">
<parameter_description> the selected action which will be taken when a drop happens,
or 0 to indicate that a drop will not be accepted
</parameter_description>
</parameter>
<parameter name="time_">
<parameter_description> the timestamp for this operation
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_drop_finish">
<description>
Ends the drag operation after a drop.

This function is called by the drag destination.

</description>
<parameters>
<parameter name="context">
<parameter_description> a #GtkDragContext
</parameter_description>
</parameter>
<parameter name="success">
<parameter_description> %TRUE if the data was successfully received
</parameter_description>
</parameter>
<parameter name="time_">
<parameter_description> the timestamp for this operation
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_drop_reply">
<description>
Accepts or rejects a drop.

This function is called by the drag destination in response
to a drop initiated by the drag source.

</description>
<parameters>
<parameter name="context">
<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
<parameter name="accepted">
<parameter_description> %TRUE if the drop is accepted
</parameter_description>
</parameter>
<parameter name="time_">
<parameter_description> the timestamp for this operation
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_error_trap_pop">
<description>
Removes an error trap pushed with gdk_error_trap_push().
May block until an error has been definitively received
or not received from the X server. gdk_error_trap_pop_ignored()
is preferred if you don't need to know whether an error
occurred, because it never has to block. If you don't
need the return value of gdk_error_trap_pop(), use
gdk_error_trap_pop_ignored().

Prior to GDK 3.0, this function would not automatically
sync for you, so you had to gdk_flush() if your last
call to Xlib was not a blocking round trip.


</description>
<parameters>
</parameters>
<return> X error code or 0 on success
</return>
</function>

<function name="gdk_error_trap_pop_ignored">
<description>
Removes an error trap pushed with gdk_error_trap_push(), but
without bothering to wait and see whether an error occurred.  If an
error arrives later asynchronously that was triggered while the
trap was pushed, that error will be ignored.

Since: 3.0

</description>
<parameters>
</parameters>
<return></return>
</function>

<function name="gdk_error_trap_push">
<description>
This function allows X errors to be trapped instead of the normal
behavior of exiting the application. It should only be used if it
is not possible to avoid the X error in any other way. Errors are
ignored on all #GdkDisplay currently known to the
#GdkDisplayManager. If you don't care which error happens and just
want to ignore everything, pop with gdk_error_trap_pop_ignored().
If you need the error code, use gdk_error_trap_pop() which may have
to block and wait for the error to arrive from the X server.

This API exists on all platforms but only does anything on X.

You can use gdk_x11_display_error_trap_push() to ignore errors
on only a single display.

&lt;example&gt;
&lt;title&gt;Trapping an X error&lt;/title&gt;
&lt;programlisting&gt;
gdk_error_trap_push (&lt;!-- --&gt;);

// ... Call the X function which may cause an error here ...


if (gdk_error_trap_pop (&lt;!-- --&gt;))
{
// ... Handle the error here ...
}
&lt;/programlisting&gt;
&lt;/example&gt;

</description>
<parameters>
</parameters>
<return></return>
</function>

<function name="gdk_event_copy">
<description>
Copies a #GdkEvent, copying or incrementing the reference count of the
resources associated with it (e.g. #GdkWindow's and strings).


</description>
<parameters>
<parameter name="event">
<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
</parameters>
<return> a copy of @event. The returned #GdkEvent should be freed with
gdk_event_free().
</return>
</function>

<function name="gdk_event_free">
<description>
Frees a #GdkEvent, freeing or decrementing any resources associated with it.
Note that this function should only be called with events returned from
functions such as gdk_event_peek(), gdk_event_get(), gdk_event_copy()
and gdk_event_new().

</description>
<parameters>
<parameter name="event">
<parameter_description>  a #GdkEvent.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_event_get">
<description>
Checks all open displays for a #GdkEvent to process,to be processed
on, fetching events from the windowing system if necessary.
See gdk_display_get_event().


</description>
<parameters>
</parameters>
<return> the next #GdkEvent to be processed, or %NULL if no events
are pending. The returned #GdkEvent should be freed with gdk_event_free().
</return>
</function>

<function name="gdk_event_get_axis">
<description>
Extract the axis value for a particular axis use from
an event structure.


</description>
<parameters>
<parameter name="event">
<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
<parameter name="axis_use">
<parameter_description> the axis use to look for
</parameter_description>
</parameter>
<parameter name="value">
<parameter_description> location to store the value found
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the specified axis was found, otherwise %FALSE
</return>
</function>

<function name="gdk_event_get_button">
<description>
Extract the button number from an event.

Since: 3.2

</description>
<parameters>
<parameter name="event">
<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
<parameter name="button">
<parameter_description> location to store mouse button number
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the event delivered a button number

</return>
</function>

<function name="gdk_event_get_click_count">
<description>
Extracts the click count from an event.

Since: 3.2

</description>
<parameters>
<parameter name="event">
<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
<parameter name="click_count">
<parameter_description> location to store click count
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the event delivered a click count

</return>
</function>

<function name="gdk_event_get_coords">
<description>
Extract the event window relative x/y coordinates from an event.


</description>
<parameters>
<parameter name="event">
<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
<parameter name="x_win">
<parameter_description> location to put event window x coordinate
</parameter_description>
</parameter>
<parameter name="y_win">
<parameter_description> location to put event window y coordinate
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the event delivered event window coordinates
</return>
</function>

<function name="gdk_event_get_device">
<description>
If the event contains a &quot;device&quot; field, this function will return
it, else it will return %NULL.

Since: 3.0

</description>
<parameters>
<parameter name="event">
<parameter_description> a #GdkEvent.
</parameter_description>
</parameter>
</parameters>
<return> a #GdkDevice, or %NULL.

</return>
</function>

<function name="gdk_event_get_event_sequence">
<description>
If @event if of type %GDK_TOUCH_BEGIN, %GDK_TOUCH_UPDATE,
%GDK_TOUCH_END or %GDK_TOUCH_CANCEL, returns the #GdkEventSequence
to which the event belongs. Otherwise, return %NULL.

Since: 3.4

</description>
<parameters>
<parameter name="event">
<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
</parameters>
<return> the event sequence that the event belongs to

</return>
</function>

<function name="gdk_event_get_keycode">
<description>
Extracts the hardware keycode from an event.

Since: 3.2

</description>
<parameters>
<parameter name="event">
<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
<parameter name="keycode">
<parameter_description> location to store the keycode
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the event delivered a hardware keycode

</return>
</function>

<function name="gdk_event_get_keyval">
<description>
Extracts the keyval from an event.

Since: 3.2

</description>
<parameters>
<parameter name="event">
<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
<parameter name="keyval">
<parameter_description> location to store the keyval
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the event delivered a key symbol

</return>
</function>

<function name="gdk_event_get_root_coords">
<description>
Extract the root window relative x/y coordinates from an event.


</description>
<parameters>
<parameter name="event">
<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
<parameter name="x_root">
<parameter_description> location to put root window x coordinate
</parameter_description>
</parameter>
<parameter name="y_root">
<parameter_description> location to put root window y coordinate
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the event delivered root window coordinates
</return>
</function>

<function name="gdk_event_get_screen">
<description>
Returns the screen for the event. The screen is
typically the screen for &lt;literal&gt;event-&gt;any.window&lt;/literal&gt;, but
for events such as mouse events, it is the screen
where the pointer was when the event occurs -
that is, the screen which has the root window 
to which &lt;literal&gt;event-&gt;motion.x_root&lt;/literal&gt; and
&lt;literal&gt;event-&gt;motion.y_root&lt;/literal&gt; are relative.

Since: 2.2

</description>
<parameters>
<parameter name="event">
<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
</parameters>
<return> the screen for the event

</return>
</function>

<function name="gdk_event_get_scroll_deltas">
<description>
Retrieves the scroll deltas from a #GdkEvent

Since: 3.4

</description>
<parameters>
<parameter name="event">
<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
<parameter name="delta_x">
<parameter_description> return location for X delta
</parameter_description>
</parameter>
<parameter name="delta_y">
<parameter_description> return location for Y delta
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the event contains smooth scroll information

</return>
</function>

<function name="gdk_event_get_scroll_direction">
<description>
Extracts the scroll direction from an event.

Since: 3.2

</description>
<parameters>
<parameter name="event">
<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
<parameter name="direction">
<parameter_description> location to store the scroll direction
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the event delivered a scroll direction

</return>
</function>

<function name="gdk_event_get_source_device">
<description>
This function returns the hardware (slave) #GdkDevice that has
triggered the event, falling back to the virtual (master) device
(as in gdk_event_get_device()) if the event wasn't caused by
interaction with a hardware device. This may happen for example
in synthesized crossing events after a #GdkWindow updates its
geometry or a grab is acquired/released.

If the event does not contain a device field, this function will
return %NULL.

Since: 3.0

</description>
<parameters>
<parameter name="event">
<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
</parameters>
<return> a #GdkDevice, or %NULL.

</return>
</function>

<function name="gdk_event_get_state">
<description>
If the event contains a &quot;state&quot; field, puts that field in @state. Otherwise
stores an empty state (0). Returns %TRUE if there was a state field
in the event. @event may be %NULL, in which case it's treated
as if the event had no state field.


</description>
<parameters>
<parameter name="event">
<parameter_description> a #GdkEvent or NULL
</parameter_description>
</parameter>
<parameter name="state">
<parameter_description> return location for state
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if there was a state field in the event 
</return>
</function>

<function name="gdk_event_get_time">
<description>
Returns the time stamp from @event, if there is one; otherwise
returns #GDK_CURRENT_TIME. If @event is %NULL, returns #GDK_CURRENT_TIME.


</description>
<parameters>
<parameter name="event">
<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
</parameters>
<return> time stamp field from @event
</return>
</function>

<function name="gdk_event_handler_set">
<description>
Sets the function to call to handle all events from GDK.

Note that GTK+ uses this to install its own event handler, so it is
usually not useful for GTK+ applications. (Although an application
can call this function then call gtk_main_do_event() to pass
events to GTK+.)

</description>
<parameters>
<parameter name="func">
<parameter_description> the function to call to handle events from GDK.
</parameter_description>
</parameter>
<parameter name="data">
<parameter_description> user data to pass to the function. 
</parameter_description>
</parameter>
<parameter name="notify">
<parameter_description> the function to call when the handler function is removed, i.e. when
gdk_event_handler_set() is called with another event handler.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_event_new">
<description>
Creates a new event of the given type. All fields are set to 0.

Since: 2.2

</description>
<parameters>
<parameter name="type">
<parameter_description> a #GdkEventType 
</parameter_description>
</parameter>
</parameters>
<return> a newly-allocated #GdkEvent. The returned #GdkEvent 
should be freed with gdk_event_free().

</return>
</function>

<function name="gdk_event_peek">
<description>
If there is an event waiting in the event queue of some open
display, returns a copy of it. See gdk_display_peek_event().


</description>
<parameters>
</parameters>
<return> a copy of the first #GdkEvent on some event queue, or %NULL if no
events are in any queues. The returned #GdkEvent should be freed with
gdk_event_free().
</return>
</function>

<function name="gdk_event_put">
<description>
Appends a copy of the given event onto the front of the event
queue for event-&gt;any.window's display, or the default event
queue if event-&gt;any.window is %NULL. See gdk_display_put_event().

</description>
<parameters>
<parameter name="event">
<parameter_description> a #GdkEvent.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_event_request_motions">
<description>
Request more motion notifies if @event is a motion notify hint event.

This function should be used instead of gdk_window_get_pointer() to
request further motion notifies, because it also works for extension
events where motion notifies are provided for devices other than the
core pointer. Coordinate extraction, processing and requesting more
motion events from a %GDK_MOTION_NOTIFY event usually works like this:

|[
{
/ * motion_event handler * /
x = motion_event-&gt;x;
y = motion_event-&gt;y;
/ * handle (x,y) motion * /
gdk_event_request_motions (motion_event); / * handles is_hint events * /
}
]|

Since: 2.12

</description>
<parameters>
<parameter name="event">
<parameter_description> a valid #GdkEvent
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_event_set_device">
<description>
Sets the device for @event to @device. The event must
have been allocated by GTK+, for instance, by
gdk_event_copy().

Since: 3.0

</description>
<parameters>
<parameter name="event">
<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
<parameter name="device">
<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_event_set_screen">
<description>
Sets the screen for @event to @screen. The event must
have been allocated by GTK+, for instance, by
gdk_event_copy().

Since: 2.2

</description>
<parameters>
<parameter name="event">
<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_event_set_source_device">
<description>
Sets the slave device for @event to @device.

The event must have been allocated by GTK+,
for instance by gdk_event_copy().

Since: 3.0

</description>
<parameters>
<parameter name="event">
<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
<parameter name="device">
<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_event_triggers_context_menu">
<description>
This function returns whether a #GdkEventButton should trigger a
context menu, according to platform conventions. The right mouse
button always triggers context menus. Additionally, if
gdk_keymap_get_modifier_mask() returns a non-0 mask for
%GDK_MODIFIER_INTENT_CONTEXT_MENU, then the left mouse button will
also trigger a context menu if this modifier is pressed.

This function should always be used instead of simply checking for
event-&gt;button == %GDK_BUTTON_SECONDARY.

Since: 3.4

</description>
<parameters>
<parameter name="event">
<parameter_description> a #GdkEvent, currently only button events are meaningful values
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the event should trigger a context menu.

</return>
</function>

<function name="gdk_events_get_angle">
<description>
If both events contain X/Y information, this function will return %TRUE
and return in @angle the relative angle from @event1 to @event2. The rotation
direction for positive angles is from the positive X axis towards the positive
Y axis.

Since: 3.0

</description>
<parameters>
<parameter name="event1">
<parameter_description> first #GdkEvent
</parameter_description>
</parameter>
<parameter name="event2">
<parameter_description> second #GdkEvent
</parameter_description>
</parameter>
<parameter name="angle">
<parameter_description> return location for the relative angle between both events
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the angle could be calculated.

</return>
</function>

<function name="gdk_events_get_center">
<description>
If both events contain X/Y information, the center of both coordinates
will be returned in @x and @y.

Since: 3.0

</description>
<parameters>
<parameter name="event1">
<parameter_description> first #GdkEvent
</parameter_description>
</parameter>
<parameter name="event2">
<parameter_description> second #GdkEvent
</parameter_description>
</parameter>
<parameter name="x">
<parameter_description> return location for the X coordinate of the center
</parameter_description>
</parameter>
<parameter name="y">
<parameter_description> return location for the Y coordinate of the center
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the center could be calculated.

</return>
</function>

<function name="gdk_events_get_distance">
<description>
If both events have X/Y information, the distance between both coordinates
(as in a straight line going from @event1 to @event2) will be returned.

Since: 3.0

</description>
<parameters>
<parameter name="event1">
<parameter_description> first #GdkEvent
</parameter_description>
</parameter>
<parameter name="event2">
<parameter_description> second #GdkEvent
</parameter_description>
</parameter>
<parameter name="distance">
<parameter_description> return location for the distance
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the distance could be calculated.

</return>
</function>

<function name="gdk_events_pending">
<description>
Checks if any events are ready to be processed for any display.


</description>
<parameters>
</parameters>
<return> %TRUE if any events are pending.
</return>
</function>

<function name="gdk_flush">
<description>
Flushes the output buffers of all display connections and waits
until all requests have been processed.
This is rarely needed by applications.

</description>
<parameters>
</parameters>
<return></return>
</function>

<function name="gdk_frame_clock_begin_updating">
<description>
Starts updates for an animation. Until a matching call to
gdk_frame_clock_end_updating() is made, the frame clock will continually
request a new frame with the %GDK_FRAME_CLOCK_PHASE_UPDATE phase.
This function may be called multiple times and frames will be
requested until gdk_frame_clock_end_updating() is called the same
number of times.

Since: 3.8

</description>
<parameters>
<parameter name="frame_clock">
<parameter_description> a #GdkFrameClock
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_frame_clock_end_updating">
<description>
Stops updates for an animation. See the documentation for
gdk_frame_clock_begin_updating().

Since: 3.8

</description>
<parameters>
<parameter name="frame_clock">
<parameter_description> a #GdkFrameClock
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_frame_clock_get_current_timings">
<description>
Gets the frame timings for the current frame.

Since: 3.8

</description>
<parameters>
<parameter name="frame_clock">
<parameter_description> a #GdkFrameClock
</parameter_description>
</parameter>
</parameters>
<return> the #GdkFrameTimings for the frame currently being
processed, or even no frame is being processed, for the
previous frame. Before any frames have been procesed,
returns %NULL.
</return>
</function>

<function name="gdk_frame_clock_get_frame_counter">
<description>
A #GdkFrameClock maintains a 64-bit counter that increments for
each frame drawn.

Since: 3.8

</description>
<parameters>
<parameter name="frame_clock">
<parameter_description> a #GdkFrameClock
</parameter_description>
</parameter>
</parameters>
<return> inside frame processing, the value of the frame counter
for the current frame. Outside of frame processing, the frame
counter for the last frame.
</return>
</function>

<function name="gdk_frame_clock_get_frame_time">
<description>
Gets the time that should currently be used for animations.  Inside
the processing of a frame, it's the time used to compute the
animation position of everything in a frame. Outside of a frame, it's
the time of the conceptual &quot;previous frame,&quot; which may be either
the actual previous frame time, or if that's too old, an updated
time.

Since: 3.8

</description>
<parameters>
<parameter name="frame_clock">
<parameter_description> a #GdkFrameClock
</parameter_description>
</parameter>
</parameters>
<return> a timestamp in microseconds, in the timescale of
of g_get_monotonic_time().
</return>
</function>

<function name="gdk_frame_clock_get_history_start">
<description>
#GdkFrameClock internally keeps a history of #GdkFrameTiming
objects for recent frames that can be retrieved with
gdk_frame_clock_get_timings(). The set of stored frames
is the set from the counter values given by
gdk_frame_clock_get_history_start() and
gdk_frame_clock_get_frame_counter(), inclusive.

Since: 3.8

</description>
<parameters>
<parameter name="frame_clock">
<parameter_description> a #GdkFrameClock
</parameter_description>
</parameter>
</parameters>
<return> the frame counter value for the oldest frame
that is available in the internal frame history of the
#GdkFrameClock.
</return>
</function>

<function name="gdk_frame_clock_get_refresh_info">
<description>
Using the frame history stored in the frame clock, finds the last
known presentation time and refresh interval, and assuming that
presentation times are separated by the refresh interval,
predicts a presentation time that is a multiple of the refresh
interval after the last presentation time, and later than @base_time.

Since: 3.8

</description>
<parameters>
<parameter name="frame_clock">
<parameter_description> a #GdkFrameClock
</parameter_description>
</parameter>
<parameter name="base_time">
<parameter_description> base time for determining a presentaton time
</parameter_description>
</parameter>
<parameter name="refresh_interval_return">
<parameter_description> a location to store the determined refresh
interval, or %NULL. A default refresh interval of 1/60th of
a second will be stored if no history is present.
</parameter_description>
</parameter>
<parameter name="presentation_time_return">
<parameter_description> a location to store the next
candidate presentation time after the given base time.
0 will be will be stored if no history is present.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_frame_clock_get_timings">
<description>
Retrieves a #GdkFrameTimings object holding timing information
for the current frame or a recent frame. The #GdkFrameTimings
object may not yet be complete: see gdk_frame_timings_get_complete().

Since: 3.8

</description>
<parameters>
<parameter name="frame_clock">
<parameter_description> a #GdkFrameClock
</parameter_description>
</parameter>
<parameter name="frame_counter">
<parameter_description> the frame counter value identifying the frame to
be received.
</parameter_description>
</parameter>
</parameters>
<return> the #GdkFrameTimings object for the specified
frame, or %NULL if it is not available. See
gdk_frame_clock_get_history_start().
</return>
</function>

<function name="gdk_frame_clock_request_phase">
<description>
Asks the frame clock to run a particular phase. The signal
corresponding the requested phase will be emitted the next
time the frame clock processes. Multiple calls to
gdk_frame_clock_request_phase() will be combined together
and only one frame processed. If you are displaying animated
content and want to continually request the
%GDK_FRAME_CLOCK_PHASE_UPDATE phase for a period of time,
you should use gdk_frame_clock_begin_updating() instead, since
this allows GTK+ to adjust system parameters to get maximally
smooth animations.

Since: 3.8

</description>
<parameters>
<parameter name="frame_clock">
<parameter_description> a #GdkFrameClock
</parameter_description>
</parameter>
<parameter name="phase">
<parameter_description> the phase that is requested
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_frame_timings_get_complete">
<description>
The timing information in a #GdkFrameTimings is filled in
incrementally as the frame as drawn and passed off to the
window system for processing and display to the user. The
accessor functions for #GdkFrameTimings can return 0 to
indicate an unavailable value for two reasons: either because
the information is not yet available, or because it isn't
available at all. Once gdk_frame_timings_complete() returns
%TRUE for a frame, you can be certain that no further values
will become available and be stored in the #GdkFrameTimings.

Since: 3.8

</description>
<parameters>
<parameter name="timings">
<parameter_description> a #GdkFrameTimings
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if all information that will be available
for the frame has been filled in.
</return>
</function>

<function name="gdk_frame_timings_get_frame_counter">
<description>
Gets the frame counter value of the #GdkFrameClock when this
this frame was drawn.

Since: 3.8

</description>
<parameters>
<parameter name="timings">
<parameter_description> a #GdkFrameTimings
</parameter_description>
</parameter>
</parameters>
<return> the frame counter value for this frame
</return>
</function>

<function name="gdk_frame_timings_get_frame_time">
<description>
Returns the frame time for the frame. This is the time value
that is typically used to time animations for the frame. See
gdk_frame_clock_get_frame_time().


</description>
<parameters>
<parameter name="timings">
<parameter_description> A #GdkFrameTimings
</parameter_description>
</parameter>
</parameters>
<return> the frame time for the frame, in the timescale
of g_get_monotonic_time()
</return>
</function>

<function name="gdk_frame_timings_get_predicted_presentation_time">
<description>
Gets the predicted time at which this frame will be displayed. Although
no predicted time may be available, if one is available, it will
be available while the frame is being generated, in contrast to
gdk_frame_timings_get_presentation_time(), which is only available
after the frame has been presented. In general, if you are simply
animating, you should use gdk_frame_clock_get_frame_time() rather
than this function, but this function is useful for applications
that want exact control over latency. For example, a movie player
may want this information for Audio/Video synchronization.

Since: 3.8

</description>
<parameters>
<parameter name="timings">
<parameter_description> a #GdkFrameTimings
</parameter_description>
</parameter>
</parameters>
<return> The predicted time at which the frame will be presented,
in the timescale of g_get_monotonic_time(), or 0 if no predicted
presentation time is available.
</return>
</function>

<function name="gdk_frame_timings_get_presentation_time">
<description>
Reurns the presentation time. This is the time at which the frame
became visible to the user.

Since: 3.8

</description>
<parameters>
<parameter name="timings">
<parameter_description> a #GdkFrameTimings
</parameter_description>
</parameter>
</parameters>
<return> the time the frame was displayed to the user, in the
timescale of g_get_monotonic_time(), or 0 if no presentation
time is available. See gdk_frame_timings_get_complete()
</return>
</function>

<function name="gdk_frame_timings_get_refresh_interval">
<description>
Gets the natural interval between presentation times for
the display that this frame was displayed on. Frame presentation
usually happens during the &quot;vertical blanking interval&quot;.

Since: 3.8

</description>
<parameters>
<parameter name="timings">
<parameter_description> a #GdkFrameTimings
</parameter_description>
</parameter>
</parameters>
<return> the refresh interval of the display, in microseconds,
or 0 if the refresh interval is not available.
See gdk_frame_timings_get_complete().
</return>
</function>

<function name="gdk_frame_timings_ref">
<description>
Increases the reference count of @timings.

Since: 3.8

</description>
<parameters>
<parameter name="timings">
<parameter_description> a #GdkFrameTimings
</parameter_description>
</parameter>
</parameters>
<return> @timings
</return>
</function>

<function name="gdk_frame_timings_unref">
<description>
Decreases the reference count of @timings. If @timings
is no longer referenced, it will be freed.

Since: 3.8

</description>
<parameters>
<parameter name="timings">
<parameter_description> a #GdkFrameTimings
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_get_default_root_window">
<description>
Obtains the root window (parent all other windows are inside)
for the default display and screen.


</description>
<parameters>
</parameters>
<return> the default root window
</return>
</function>

<function name="gdk_get_display">
<description>
Gets the name of the display, which usually comes from the
&lt;envar&gt;DISPLAY&lt;/envar&gt; environment variable or the
&lt;option&gt;--display&lt;/option&gt; command line option.


</description>
<parameters>
</parameters>
<return> the name of the display.
</return>
</function>

<function name="gdk_get_display_arg_name">
<description>
Gets the display name specified in the command line arguments passed
to gdk_init() or gdk_parse_args(), if any.

Since: 2.2

</description>
<parameters>
</parameters>
<return> the display name, if specified explicitely, otherwise %NULL
this string is owned by GTK+ and must not be modified or freed.

</return>
</function>

<function name="gdk_get_program_class">
<description>
Gets the program class. Unless the program class has explicitly
been set with gdk_set_program_class() or with the &lt;option&gt;--class&lt;/option&gt;
commandline option, the default value is the program name (determined
with g_get_prgname()) with the first character converted to uppercase.


</description>
<parameters>
</parameters>
<return> the program class.
</return>
</function>

<function name="gdk_get_show_events">
<description>
Gets whether event debugging output is enabled.


</description>
<parameters>
</parameters>
<return> %TRUE if event debugging output is enabled.
</return>
</function>

<function name="gdk_init">
<description>
Initializes the GDK library and connects to the windowing system.
If initialization fails, a warning message is output and the application
terminates with a call to &lt;literal&gt;exit(1)&lt;/literal&gt;.

Any arguments used by GDK are removed from the array and @argc and @argv
are updated accordingly.

GTK+ initializes GDK in gtk_init() and so this function is not usually
needed by GTK+ applications.

</description>
<parameters>
<parameter name="argc">
<parameter_description> the number of command line arguments.
</parameter_description>
</parameter>
<parameter name="argv">
<parameter_description> the array of command line arguments.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_init_check">
<description>
Initializes the GDK library and connects to the windowing system,
returning %TRUE on success.

Any arguments used by GDK are removed from the array and @argc and @argv
are updated accordingly.

GTK+ initializes GDK in gtk_init() and so this function is not usually
needed by GTK+ applications.


</description>
<parameters>
<parameter name="argc">
<parameter_description> the number of command line arguments.
</parameter_description>
</parameter>
<parameter name="argv">
<parameter_description> the array of command line arguments.
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if initialization succeeded.
</return>
</function>

<function name="gdk_keyboard_grab">
<description>
Grabs the keyboard so that all events are passed to this
application until the keyboard is ungrabbed with gdk_keyboard_ungrab().
This overrides any previous keyboard grab by this client.

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 #GdkEventGrabBroken events that
are emitted when the grab ends unvoluntarily.

Deprecated: 3.0: Use gdk_device_grab() instead.

</description>
<parameters>
<parameter name="window">
<parameter_description> the #GdkWindow which will own the grab (the grab window).
</parameter_description>
</parameter>
<parameter name="owner_events">
<parameter_description> if %FALSE then all keyboard events are reported with respect to
@window. If %TRUE then keyboard events for this application are
reported as normal, but keyboard events outside this application
are reported with respect to @window. Both key press and key
release events are always reported, independant of the event mask
set by the application.
</parameter_description>
</parameter>
<parameter name="time_">
<parameter_description> a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no timestamp is
available.
</parameter_description>
</parameter>
</parameters>
<return> %GDK_GRAB_SUCCESS if the grab was successful.

</return>
</function>

<function name="gdk_keyboard_ungrab">
<description>
Ungrabs the keyboard on the default display, if it is grabbed by this 
application.

Deprecated: 3.0: Use gdk_device_ungrab(), together with gdk_device_grab()
instead.

</description>
<parameters>
<parameter name="time_">
<parameter_description> a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no
timestamp is available.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_keymap_add_virtual_modifiers">
<description>
Maps the non-virtual modifiers (i.e Mod2, Mod3, ...) which are set
in @state to the virtual modifiers (i.e. Super, Hyper and Meta) and
set the corresponding bits in @state.

GDK already does this before delivering key events, but for
compatibility reasons, it only sets the first virtual modifier
it finds, whereas this function sets all matching virtual modifiers.

This function is useful when matching key events against
accelerators.

Since: 2.20

</description>
<parameters>
<parameter name="keymap">
<parameter_description> a #GdkKeymap
</parameter_description>
</parameter>
<parameter name="state">
<parameter_description> pointer to the modifier mask to change
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_keymap_get_caps_lock_state">
<description>
Returns whether the Caps Lock modifer is locked.

Since: 2.16

</description>
<parameters>
<parameter name="keymap">
<parameter_description> a #GdkKeymap
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if Caps Lock is on

</return>
</function>

<function name="gdk_keymap_get_default">
<description>
Returns the #GdkKeymap attached to the default display.


</description>
<parameters>
</parameters>
<return> the #GdkKeymap attached to the default display.
</return>
</function>

<function name="gdk_keymap_get_direction">
<description>
Returns the direction of effective layout of the keymap.


</description>
<parameters>
<parameter name="keymap">
<parameter_description> a #GdkKeymap
</parameter_description>
</parameter>
</parameters>
<return> %PANGO_DIRECTION_LTR or %PANGO_DIRECTION_RTL
if it can determine the direction. %PANGO_DIRECTION_NEUTRAL
otherwise.
</return>
</function>

<function name="gdk_keymap_get_entries_for_keycode">
<description>
Returns the keyvals bound to @hardware_keycode.
The Nth #GdkKeymapKey in @keys is bound to the Nth
keyval in @keyvals. Free the returned arrays with g_free().
When a keycode is pressed by the user, the keyval from
this list of entries is selected by considering the effective
keyboard group and level. See gdk_keymap_translate_keyboard_state().


</description>
<parameters>
<parameter name="keymap">
<parameter_description> a #GdkKeymap
</parameter_description>
</parameter>
<parameter name="hardware_keycode">
<parameter_description> a keycode
</parameter_description>
</parameter>
<parameter name="keys">
<parameter_description> return
location for array of #GdkKeymapKey, or %NULL
</parameter_description>
</parameter>
<parameter name="keyvals">
<parameter_description> return
location for array of keyvals, or %NULL
</parameter_description>
</parameter>
<parameter name="n_entries">
<parameter_description> length of @keys and @keyvals
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if there were any entries
</return>
</function>

<function name="gdk_keymap_get_entries_for_keyval">
<description>
Obtains a list of keycode/group/level combinations that will
generate @keyval. Groups and levels are two kinds of keyboard mode;
in general, the level determines whether the top or bottom symbol
on a key is used, and the group determines whether the left or
right symbol is used. On US keyboards, the shift key changes the
keyboard level, and there are no groups. A group switch key might
convert a keyboard between Hebrew to English modes, for example.
#GdkEventKey contains a %group field that indicates the active
keyboard group. The level is computed from the modifier mask.
The returned array should be freed
with g_free().


</description>
<parameters>
<parameter name="keymap">
<parameter_description> a #GdkKeymap
</parameter_description>
</parameter>
<parameter name="keyval">
<parameter_description> a keyval, such as %GDK_a, %GDK_Up, %GDK_Return, etc.
</parameter_description>
</parameter>
<parameter name="keys">
<parameter_description> return location
for an array of #GdkKeymapKey
</parameter_description>
</parameter>
<parameter name="n_keys">
<parameter_description> return location for number of elements in returned array
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if keys were found and returned
</return>
</function>

<function name="gdk_keymap_get_for_display">
<description>
Returns the #GdkKeymap attached to @display.

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description> the #GdkDisplay.
</parameter_description>
</parameter>
</parameters>
<return> the #GdkKeymap attached to @display.

</return>
</function>

<function name="gdk_keymap_get_modifier_mask">
<description>
Returns the modifier mask the @keymap's windowing system backend
uses for a particular purpose.

Note that this function always returns real hardware modifiers, not
virtual ones (e.g. it will return #GDK_MOD1_MASK rather than
#GDK_META_MASK if the backend maps MOD1 to META), so there are use
cases where the return value of this function has to be transformed
by gdk_keymap_add_virtual_modifiers() in order to contain the
expected result.

Since: 3.4

</description>
<parameters>
<parameter name="keymap">
<parameter_description> a #GdkKeymap
</parameter_description>
</parameter>
<parameter name="intent">
<parameter_description> the use case for the modifier mask
</parameter_description>
</parameter>
</parameters>
<return> the modifier mask used for @intent.

</return>
</function>

<function name="gdk_keymap_get_modifier_state">
<description>
Returns the current modifier state.

Since: 3.4

</description>
<parameters>
<parameter name="keymap">
<parameter_description> a #GdkKeymap
</parameter_description>
</parameter>
</parameters>
<return> the current modifier state.

</return>
</function>

<function name="gdk_keymap_get_num_lock_state">
<description>
Returns whether the Num Lock modifer is locked.

Since: 3.0

</description>
<parameters>
<parameter name="keymap">
<parameter_description> a #GdkKeymap
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if Num Lock is on

</return>
</function>

<function name="gdk_keymap_have_bidi_layouts">
<description>
Determines if keyboard layouts for both right-to-left and left-to-right
languages are in use.

Since: 2.12

</description>
<parameters>
<parameter name="keymap">
<parameter_description> a #GdkKeymap
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if there are layouts in both directions, %FALSE otherwise

</return>
</function>

<function name="gdk_keymap_lookup_key">
<description>
Looks up the keyval mapped to a keycode/group/level triplet.
If no keyval is bound to @key, returns 0. For normal user input,
you want to use gdk_keymap_translate_keyboard_state() instead of
this function, since the effective group/level may not be
the same as the current keyboard state.


</description>
<parameters>
<parameter name="keymap">
<parameter_description> a #GdkKeymap
</parameter_description>
</parameter>
<parameter name="key">
<parameter_description> a #GdkKeymapKey with keycode, group, and level initialized
</parameter_description>
</parameter>
</parameters>
<return> a keyval, or 0 if none was mapped to the given @key
</return>
</function>

<function name="gdk_keymap_map_virtual_modifiers">
<description>
Maps the virtual modifiers (i.e. Super, Hyper and Meta) which
are set in @state to their non-virtual counterparts (i.e. Mod2,
Mod3,...) and set the corresponding bits in @state.

This function is useful when matching key events against
accelerators.

Since: 2.20

</description>
<parameters>
<parameter name="keymap">
<parameter_description> a #GdkKeymap
</parameter_description>
</parameter>
<parameter name="state">
<parameter_description> pointer to the modifier state to map
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if no virtual modifiers were mapped to the
same non-virtual modifier. Note that %FALSE is also returned
if a virtual modifier is mapped to a non-virtual modifier that
was already set in @state.

</return>
</function>

<function name="gdk_keymap_translate_keyboard_state">
<description>
Translates the contents of a #GdkEventKey into a keyval, effective
group, and level. Modifiers that affected the translation and
are thus unavailable for application use are returned in
@consumed_modifiers.
See &lt;xref linkend=&quot;key-group-explanation&quot;/&gt; for an explanation of
groups and levels. The @effective_group is the group that was
actually used for the translation; some keys such as Enter are not
affected by the active keyboard group. The @level is derived from
@state. For convenience, #GdkEventKey already contains the translated
keyval, so this function isn't as useful as you might think.

&lt;note&gt;&lt;para&gt;
@consumed_modifiers gives modifiers that should be masked out
from @state when comparing this key press to a hot key. For
instance, on a US keyboard, the &lt;literal&gt;plus&lt;/literal&gt;
symbol is shifted, so when comparing a key press to a
&lt;literal&gt;&lt;Control&gt;plus&lt;/literal&gt; accelerator &lt;Shift&gt; should
be masked out.
&lt;/para&gt;
&lt;informalexample&gt;&lt;programlisting&gt;
 / * We want to ignore irrelevant modifiers like ScrollLock * / 
&#35;define ALL_ACCELS_MASK (GDK_CONTROL_MASK | GDK_SHIFT_MASK | GDK_MOD1_MASK)
gdk_keymap_translate_keyboard_state (keymap, event-&gt;hardware_keycode,
event-&gt;state, event-&gt;group,
&amp;keyval, NULL, NULL, &amp;consumed);
if (keyval == GDK_PLUS &amp;&amp;
(event-&gt;state &amp; ~consumed &amp; ALL_ACCELS_MASK) == GDK_CONTROL_MASK)
 / * Control was pressed * / 
&lt;/programlisting&gt;&lt;/informalexample&gt;
&lt;para&gt;
An older interpretation @consumed_modifiers was that it contained
all modifiers that might affect the translation of the key;
this allowed accelerators to be stored with irrelevant consumed
modifiers, by doing:&lt;/para&gt;
&lt;informalexample&gt;&lt;programlisting&gt;
 / * XXX Don't do this XXX * / 
if (keyval == accel_keyval &amp;&amp;
(event-&gt;state &amp; ~consumed &amp; ALL_ACCELS_MASK) == (accel_mods &amp; ~consumed))
 / * Accelerator was pressed * / 
&lt;/programlisting&gt;&lt;/informalexample&gt;
&lt;para&gt;
However, this did not work if multi-modifier combinations were
used in the keymap, since, for instance, &lt;literal&gt;&lt;Control&gt;&lt;/literal&gt;
would be masked out even if only &lt;literal&gt;&lt;Control&gt;&lt;Alt&gt;&lt;/literal&gt;
was used in the keymap. To support this usage as well as well as
possible, all &lt;emphasis&gt;single modifier&lt;/emphasis&gt; combinations
that could affect the key for any combination of modifiers will
be returned in @consumed_modifiers; multi-modifier combinations
are returned only when actually found in @state. When you store
accelerators, you should always store them with consumed modifiers
removed. Store &lt;literal&gt;&lt;Control&gt;plus&lt;/literal&gt;,
not &lt;literal&gt;&lt;Control&gt;&lt;Shift&gt;plus&lt;/literal&gt;,
&lt;/para&gt;&lt;/note&gt;


</description>
<parameters>
<parameter name="keymap">
<parameter_description> a #GdkKeymap
</parameter_description>
</parameter>
<parameter name="hardware_keycode">
<parameter_description> a keycode
</parameter_description>
</parameter>
<parameter name="state">
<parameter_description> a modifier state
</parameter_description>
</parameter>
<parameter name="group">
<parameter_description> active keyboard group
</parameter_description>
</parameter>
<parameter name="keyval">
<parameter_description> return location for keyval, or %NULL
</parameter_description>
</parameter>
<parameter name="effective_group">
<parameter_description> return location for effective
group, or %NULL
</parameter_description>
</parameter>
<parameter name="level">
<parameter_description> return location for level, or %NULL
</parameter_description>
</parameter>
<parameter name="consumed_modifiers">
<parameter_description> return location for modifiers
that were used to determine the group or level, or %NULL
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if there was a keyval bound to the keycode/state/group
</return>
</function>

<function name="gdk_keyval_convert_case">
<description>
Obtains the upper- and lower-case versions of the keyval @symbol.
Examples of keyvals are #GDK_KEY_a, #GDK_KEY_Enter, #GDK_KEY_F1, etc.

</description>
<parameters>
<parameter name="symbol">
<parameter_description> a keyval
</parameter_description>
</parameter>
<parameter name="lower">
<parameter_description> return location for lowercase version of @symbol
</parameter_description>
</parameter>
<parameter name="upper">
<parameter_description> return location for uppercase version of @symbol
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_keyval_from_name">
<description>
Converts a key name to a key value.

The names are the same as those in the
&lt;filename&gt;&lt;gdk/gdkkeysyms.h&gt;&lt;/filename&gt; header file
but without the leading &quot;GDK_KEY_&quot;.


</description>
<parameters>
<parameter name="keyval_name">
<parameter_description> a key name
</parameter_description>
</parameter>
</parameters>
<return> the corresponding key value, or %GDK_KEY_VoidSymbol
if the key name is not a valid key
</return>
</function>

<function name="gdk_keyval_is_lower">
<description>
Returns %TRUE if the given key value is in lower case.


</description>
<parameters>
<parameter name="keyval">
<parameter_description> a key value.
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if @keyval is in lower case, or if @keyval is not
subject to case conversion.
</return>
</function>

<function name="gdk_keyval_is_upper">
<description>
Returns %TRUE if the given key value is in upper case.


</description>
<parameters>
<parameter name="keyval">
<parameter_description> a key value.
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if @keyval is in upper case, or if @keyval is not subject to
case conversion.
</return>
</function>

<function name="gdk_keyval_name">
<description>
Converts a key value into a symbolic name.

The names are the same as those in the
&lt;filename&gt;&lt;gdk/gdkkeysyms.h&gt;&lt;/filename&gt; header file
but without the leading &quot;GDK_KEY_&quot;.


</description>
<parameters>
<parameter name="keyval">
<parameter_description> a key value
</parameter_description>
</parameter>
</parameters>
<return> a string containing the name of the key,
or %NULL if @keyval is not a valid key. The string should not be
modified.
</return>
</function>

<function name="gdk_keyval_to_lower">
<description>
Converts a key value to lower case, if applicable.


</description>
<parameters>
<parameter name="keyval">
<parameter_description> a key value.
</parameter_description>
</parameter>
</parameters>
<return> the lower case form of @keyval, or @keyval itself if it is already
in lower case or it is not subject to case conversion.
</return>
</function>

<function name="gdk_keyval_to_unicode">
<description>
Convert from a GDK key symbol to the corresponding ISO10646 (Unicode)
character.


</description>
<parameters>
<parameter name="keyval">
<parameter_description> a GDK key symbol 
</parameter_description>
</parameter>
</parameters>
<return> the corresponding unicode character, or 0 if there
is no corresponding character.
</return>
</function>

<function name="gdk_keyval_to_upper">
<description>
Converts a key value to upper case, if applicable.


</description>
<parameters>
<parameter name="keyval">
<parameter_description> a key value.
</parameter_description>
</parameter>
</parameters>
<return> the upper case form of @keyval, or @keyval itself if it is already
in upper case or it is not subject to case conversion.
</return>
</function>

<function name="gdk_list_visuals">
<description>
Lists the available visuals for the default screen.
(See gdk_screen_list_visuals())
A visual describes a hardware image data format.
For example, a visual might support 24-bit color, or 8-bit color,
and might expect pixels to be in a certain format.

Call g_list_free() on the return value when you're finished with it.


</description>
<parameters>
</parameters>
<return>
a list of visuals; the list must be freed, but not its contents
</return>
</function>

<function name="gdk_notify_startup_complete">
<description>
Indicates to the GUI environment that the application has finished
loading. If the applications opens windows, this function is
normally called after opening the application's initial set of
windows.

GTK+ will call this function automatically after opening the first
#GtkWindow unless gtk_window_set_auto_startup_notification() is called
to disable that feature.

Since: 2.2

</description>
<parameters>
</parameters>
<return></return>
</function>

<function name="gdk_notify_startup_complete_with_id">
<description>
Indicates to the GUI environment that the application has
finished loading, using a given identifier.

GTK+ will call this function automatically for #GtkWindow
with custom startup-notification identifier unless
gtk_window_set_auto_startup_notification() is called to
disable that feature.

Since: 2.12

</description>
<parameters>
<parameter name="startup_id">
<parameter_description> a startup-notification identifier, for which
notification process should be completed
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_offscreen_window_get_embedder">
<description>
Gets the window that @window is embedded in.

Since: 2.18

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> the embedding #GdkWindow, or %NULL
if @window is not an mbedded offscreen window

</return>
</function>

<function name="gdk_offscreen_window_get_surface">
<description>
Gets the offscreen surface that an offscreen window renders into.
If you need to keep this around over window resizes, you need to
add a reference to it.


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> The offscreen surface, or %NULL if not offscreen
</return>
</function>

<function name="gdk_offscreen_window_set_embedder">
<description>
Sets @window to be embedded in @embedder.

To fully embed an offscreen window, in addition to calling this
function, it is also necessary to handle the #GdkWindow::pick-embedded-child
signal on the @embedder and the #GdkWindow::to-embedder and
#GdkWindow::from-embedder signals on @window.

Since: 2.18

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="embedder">
<parameter_description> the #GdkWindow that @window gets embedded in
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_pango_context_get">
<description>
Creates a #PangoContext for the default GDK screen.

The context must be freed when you're finished with it.

When using GTK+, normally you should use gtk_widget_get_pango_context()
instead of this function, to get the appropriate context for
the widget you intend to render text onto.

The newly created context will have the default font options (see
#cairo_font_options_t) for the default screen; if these options
change it will not be updated. Using gtk_widget_get_pango_context()
is more convenient if you want to keep a context around and track
changes to the screen's font rendering settings.


</description>
<parameters>
</parameters>
<return> a new #PangoContext for the default display
</return>
</function>

<function name="gdk_pango_context_get_for_screen">
<description>
Creates a #PangoContext for @screen.

The context must be freed when you're finished with it.

When using GTK+, normally you should use gtk_widget_get_pango_context()
instead of this function, to get the appropriate context for
the widget you intend to render text onto.

The newly created context will have the default font options
(see #cairo_font_options_t) for the screen; if these options
change it will not be updated. Using gtk_widget_get_pango_context()
is more convenient if you want to keep a context around and track
changes to the screen's font rendering settings.

Since: 2.2

</description>
<parameters>
<parameter name="screen">
<parameter_description> the #GdkScreen for which the context is to be created.
</parameter_description>
</parameter>
</parameters>
<return> a new #PangoContext for @screen

</return>
</function>

<function name="gdk_pango_layout_get_clip_region">
<description>
Obtains a clip region which contains the areas where the given ranges
of text would be drawn. @x_origin and @y_origin are the top left point
to center the layout. @index_ranges should contain
ranges of bytes in the layout's text.

Note that the regions returned correspond to logical extents of the text
ranges, not ink extents. So the drawn layout may in fact touch areas out of
the clip region.  The clip region is mainly useful for highlightling parts
of text, such as when text is selected.


</description>
<parameters>
<parameter name="layout">
<parameter_description> a #PangoLayout 
</parameter_description>
</parameter>
<parameter name="x_origin">
<parameter_description> X pixel where you intend to draw the layout with this clip
</parameter_description>
</parameter>
<parameter name="y_origin">
<parameter_description> Y pixel where you intend to draw the layout with this clip
</parameter_description>
</parameter>
<parameter name="index_ranges">
<parameter_description> array of byte indexes into the layout, where even members of array are start indexes and odd elements are end indexes
</parameter_description>
</parameter>
<parameter name="n_ranges">
<parameter_description> number of ranges in @index_ranges, i.e. half the size of @index_ranges
</parameter_description>
</parameter>
</parameters>
<return> a clip region containing the given ranges
</return>
</function>

<function name="gdk_pango_layout_line_get_clip_region">
<description>
Obtains a clip region which contains the areas where the given
ranges of text would be drawn. @x_origin and @y_origin are the top left
position of the layout. @index_ranges
should contain ranges of bytes in the layout's text. The clip
region will include space to the left or right of the line (to the
layout bounding box) if you have indexes above or below the indexes
contained inside the line. This is to draw the selection all the way
to the side of the layout. However, the clip region is in line coordinates,
not layout coordinates.

Note that the regions returned correspond to logical extents of the text
ranges, not ink extents. So the drawn line may in fact touch areas out of
the clip region.  The clip region is mainly useful for highlightling parts
of text, such as when text is selected.


</description>
<parameters>
<parameter name="line">
<parameter_description> a #PangoLayoutLine 
</parameter_description>
</parameter>
<parameter name="x_origin">
<parameter_description> X pixel where you intend to draw the layout line with this clip
</parameter_description>
</parameter>
<parameter name="y_origin">
<parameter_description> baseline pixel where you intend to draw the layout line with this clip
</parameter_description>
</parameter>
<parameter name="index_ranges">
<parameter_description> array of byte indexes into the layout,
where even members of array are start indexes and odd elements
are end indexes
</parameter_description>
</parameter>
<parameter name="n_ranges">
<parameter_description> number of ranges in @index_ranges, i.e. half the size of @index_ranges
</parameter_description>
</parameter>
</parameters>
<return> a clip region containing the given ranges
</return>
</function>

<function name="gdk_parse_args">
<description>
Parse command line arguments, and store for future
use by calls to gdk_display_open().

Any arguments used by GDK are removed from the array and @argc and @argv are
updated accordingly.

You shouldn't call this function explicitely if you are using
gtk_init(), gtk_init_check(), gdk_init(), or gdk_init_check().

Since: 2.2

</description>
<parameters>
<parameter name="argc">
<parameter_description> the number of command line arguments.
</parameter_description>
</parameter>
<parameter name="argv">
<parameter_description> the array of command line arguments.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_pixbuf_add_alpha">
<description>
Takes an existing pixbuf and adds an alpha channel to it.
If the existing pixbuf already had an alpha channel, the channel
values are copied from the original; otherwise, the alpha channel
is initialized to 255 (full opacity).

If @substitute_color is %TRUE, then the color specified by (@r, @g, @b) will be
assigned zero opacity. That is, if you pass (255, 255, 255) for the
substitute color, all white pixels will become fully transparent.


</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> A #GdkPixbuf.
</parameter_description>
</parameter>
<parameter name="substitute_color">
<parameter_description> Whether to set a color to zero opacity.  If this
is %FALSE, then the (@r, @g, @b) arguments will be ignored.
</parameter_description>
</parameter>
<parameter name="r">
<parameter_description> Red value to substitute.
</parameter_description>
</parameter>
<parameter name="g">
<parameter_description> Green value to substitute.
</parameter_description>
</parameter>
<parameter name="b">
<parameter_description> Blue value to substitute.
</parameter_description>
</parameter>
</parameters>
<return> A newly-created pixbuf with a reference count of 1.
</return>
</function>

<function name="gdk_pixbuf_animation_get_height">
<description>
Queries the height of the bounding box of a pixbuf animation.


</description>
<parameters>
<parameter name="animation">
<parameter_description> An animation.
</parameter_description>
</parameter>
</parameters>
<return> Height of the bounding box of the animation.
</return>
</function>

<function name="gdk_pixbuf_animation_get_iter">
<description>
Get an iterator for displaying an animation. The iterator provides
the frames that should be displayed at a given time.
It should be freed after use with g_object_unref().

@start_time would normally come from g_get_current_time(), and
marks the beginning of animation playback. After creating an
iterator, you should immediately display the pixbuf returned by
gdk_pixbuf_animation_iter_get_pixbuf(). Then, you should install a
timeout (with g_timeout_add()) or by some other mechanism ensure
that you'll update the image after
gdk_pixbuf_animation_iter_get_delay_time() milliseconds. Each time
the image is updated, you should reinstall the timeout with the new,
possibly-changed delay time.

As a shortcut, if @start_time is %NULL, the result of
g_get_current_time() will be used automatically.

To update the image (i.e. possibly change the result of
gdk_pixbuf_animation_iter_get_pixbuf() to a new frame of the animation),
call gdk_pixbuf_animation_iter_advance().

If you're using #GdkPixbufLoader, in addition to updating the image
after the delay time, you should also update it whenever you
receive the area_updated signal and
gdk_pixbuf_animation_iter_on_currently_loading_frame() returns
%TRUE. In this case, the frame currently being fed into the loader
has received new data, so needs to be refreshed. The delay time for
a frame may also be modified after an area_updated signal, for
example if the delay time for a frame is encoded in the data after
the frame itself. So your timeout should be reinstalled after any
area_updated signal.

A delay time of -1 is possible, indicating &quot;infinite.&quot;


</description>
<parameters>
<parameter name="animation">
<parameter_description> a #GdkPixbufAnimation
</parameter_description>
</parameter>
<parameter name="start_time">
<parameter_description> time when the animation starts playing
</parameter_description>
</parameter>
</parameters>
<return> an iterator to move over the animation
</return>
</function>

<function name="gdk_pixbuf_animation_get_static_image">
<description>
If an animation is really just a plain image (has only one frame),
this function returns that image. If the animation is an animation,
this function returns a reasonable thing to display as a static
unanimated image, which might be the first frame, or something more
sophisticated. If an animation hasn't loaded any frames yet, this
function will return %NULL.


</description>
<parameters>
<parameter name="animation">
<parameter_description> a #GdkPixbufAnimation
</parameter_description>
</parameter>
</parameters>
<return> unanimated image representing the animation
</return>
</function>

<function name="gdk_pixbuf_animation_get_width">
<description>
Queries the width of the bounding box of a pixbuf animation.


</description>
<parameters>
<parameter name="animation">
<parameter_description> An animation.
</parameter_description>
</parameter>
</parameters>
<return> Width of the bounding box of the animation.
</return>
</function>

<function name="gdk_pixbuf_animation_is_static_image">
<description>
If you load a file with gdk_pixbuf_animation_new_from_file() and it turns
out to be a plain, unanimated image, then this function will return
%TRUE. Use gdk_pixbuf_animation_get_static_image() to retrieve
the image.


</description>
<parameters>
<parameter name="animation">
<parameter_description> a #GdkPixbufAnimation
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the &quot;animation&quot; was really just an image
</return>
</function>

<function name="gdk_pixbuf_animation_iter_advance">
<description>
Possibly advances an animation to a new frame. Chooses the frame based
on the start time passed to gdk_pixbuf_animation_get_iter().

@current_time would normally come from g_get_current_time(), and
must be greater than or equal to the time passed to
gdk_pixbuf_animation_get_iter(), and must increase or remain
unchanged each time gdk_pixbuf_animation_iter_get_pixbuf() is
called. That is, you can't go backward in time; animations only
play forward.

As a shortcut, pass %NULL for the current time and g_get_current_time()
will be invoked on your behalf. So you only need to explicitly pass
@current_time if you're doing something odd like playing the animation
at double speed.

If this function returns %FALSE, there's no need to update the animation
display, assuming the display had been rendered prior to advancing;
if %TRUE, you need to call gdk_pixbuf_animation_iter_get_pixbuf()
and update the display with the new pixbuf.


</description>
<parameters>
<parameter name="iter">
<parameter_description> a #GdkPixbufAnimationIter
</parameter_description>
</parameter>
<parameter name="current_time">
<parameter_description> current time
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the image may need updating

</return>
</function>

<function name="gdk_pixbuf_animation_iter_get_delay_time">
<description>
Gets the number of milliseconds the current pixbuf should be displayed,
or -1 if the current pixbuf should be displayed forever. g_timeout_add()
conveniently takes a timeout in milliseconds, so you can use a timeout
to schedule the next update.


</description>
<parameters>
<parameter name="iter">
<parameter_description> an animation iterator
</parameter_description>
</parameter>
</parameters>
<return> delay time in milliseconds (thousandths of a second)
</return>
</function>

<function name="gdk_pixbuf_animation_iter_get_pixbuf">
<description>
Gets the current pixbuf which should be displayed; the pixbuf might not
be the same size as the animation itself
(gdk_pixbuf_animation_get_width(), gdk_pixbuf_animation_get_height()). 
This pixbuf should be displayed for 
gdk_pixbuf_animation_iter_get_delay_time() milliseconds.  The caller
of this function does not own a reference to the returned pixbuf;
the returned pixbuf will become invalid when the iterator advances
to the next frame, which may happen anytime you call
gdk_pixbuf_animation_iter_advance(). Copy the pixbuf to keep it
(don't just add a reference), as it may get recycled as you advance
the iterator.


</description>
<parameters>
<parameter name="iter">
<parameter_description> an animation iterator
</parameter_description>
</parameter>
</parameters>
<return> the pixbuf to be displayed
</return>
</function>

<function name="gdk_pixbuf_animation_iter_on_currently_loading_frame">
<description>
Used to determine how to respond to the area_updated signal on
#GdkPixbufLoader when loading an animation. area_updated is emitted
for an area of the frame currently streaming in to the loader. So if
you're on the currently loading frame, you need to redraw the screen for
the updated area.


</description>
<parameters>
<parameter name="iter">
<parameter_description> a #GdkPixbufAnimationIter
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the frame we're on is partially loaded, or the last frame
</return>
</function>

<function name="gdk_pixbuf_animation_new_from_file">
<description>
Creates a new animation by loading it from a file.  The file format is
detected automatically.  If the file's format does not support multi-frame
images, then an animation with a single frame will be created. Possible errors
are in the #GDK_PIXBUF_ERROR and #G_FILE_ERROR domains.


</description>
<parameters>
<parameter name="filename">
<parameter_description> Name of file to load, in the GLib file name encoding
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> return location for error
</parameter_description>
</parameter>
</parameters>
<return> A newly-created animation with a reference count of 1, or %NULL
if any of several error conditions ocurred:  the file could not be opened,
there was no loader for the file's format, there was not enough memory to
allocate the image buffer, or the image file contained invalid data.
</return>
</function>

<function name="gdk_pixbuf_animation_new_from_resource">
<description>
Creates a new pixbuf animation by loading an image from an resource.

The file format is detected automatically. If %NULL is returned, then
@error will be set.

Since: 2.28

</description>
<parameters>
<parameter name="resource_path">
<parameter_description> the path of the resource file
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> Return location for an error
</parameter_description>
</parameter>
</parameters>
<return> A newly-created animation, or %NULL if any of several error
conditions occurred: the file could not be opened, the image format is
not supported, there was not enough memory to allocate the image buffer,
the stream contained invalid data, or the operation was cancelled.

</return>
</function>

<function name="gdk_pixbuf_animation_new_from_stream">
<description>
Creates a new animation by loading it from an input stream.

The file format is detected automatically. If %NULL is returned, then 
@error will be set. The @cancellable can be used to abort the operation
from another thread. If the operation was cancelled, the error 
%G_IO_ERROR_CANCELLED will be returned. Other possible errors are in 
the #GDK_PIXBUF_ERROR and %G_IO_ERROR domains. 

The stream is not closed.

Since: 2.28

</description>
<parameters>
<parameter name="stream">
<parameter_description>  a #GInputStream to load the pixbuf from
</parameter_description>
</parameter>
<parameter name="cancellable">
<parameter_description> optional #GCancellable object, %NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> Return location for an error
</parameter_description>
</parameter>
</parameters>
<return> A newly-created pixbuf, or %NULL if any of several error 
conditions occurred: the file could not be opened, the image format is 
not supported, there was not enough memory to allocate the image buffer, 
the stream contained invalid data, or the operation was cancelled.

</return>
</function>

<function name="gdk_pixbuf_animation_new_from_stream_async">
<description>
Creates a new animation by asynchronously loading an image from an input stream.

For more details see gdk_pixbuf_new_from_stream(), which is the synchronous
version of this function.

When the operation is finished, @callback will be called in the main thread.
You can then call gdk_pixbuf_animation_new_from_stream_finish() to get the
result of the operation.

Since: 2.28

</description>
<parameters>
<parameter name="stream">
<parameter_description> a #GInputStream from which to load the animation
</parameter_description>
</parameter>
<parameter name="cancellable">
<parameter_description> optional #GCancellable object, %NULL to ignore
</parameter_description>
</parameter>
<parameter name="callback">
<parameter_description> a #GAsyncReadyCallback to call when the the pixbuf is loaded
</parameter_description>
</parameter>
<parameter name="user_data">
<parameter_description> the data to pass to the callback function
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_pixbuf_animation_new_from_stream_finish">
<description>
Finishes an asynchronous pixbuf animation creation operation started with
gdk_pixbuf_animation_new_from_stream_async().

Since: 2.28

</description>
<parameters>
<parameter name="async_result">
<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
<return> a #GdkPixbufAnimation or %NULL on error. Free the returned
object with g_object_unref().

</return>
</function>

<function name="gdk_pixbuf_animation_ref">
<description>
Adds a reference to an animation.

Deprecated: 2.0: Use g_object_ref().

</description>
<parameters>
<parameter name="animation">
<parameter_description> An animation.
</parameter_description>
</parameter>
</parameters>
<return> The same as the @animation argument.

</return>
</function>

<function name="gdk_pixbuf_animation_unref">
<description>
Removes a reference from an animation.

Deprecated: 2.0: Use g_object_unref().

</description>
<parameters>
<parameter name="animation">
<parameter_description> An animation.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_pixbuf_apply_embedded_orientation">
<description>
Takes an existing pixbuf and checks for the presence of an
associated &quot;orientation&quot; option, which may be provided by the 
jpeg loader (which reads the exif orientation tag) or the 
tiff loader (which reads the tiff orientation tag, and
compensates it for the partial transforms performed by 
libtiff). If an orientation option/tag is present, the
appropriate transform will be performed so that the pixbuf
is oriented correctly.

Since: 2.12

</description>
<parameters>
<parameter name="src">
<parameter_description> A #GdkPixbuf.
</parameter_description>
</parameter>
</parameters>
<return> A newly-created pixbuf, or a reference to the
input pixbuf (with an increased reference count).

</return>
</function>

<function name="gdk_pixbuf_composite">
<description>
Creates a transformation of the source image @src by scaling by
@scale_x and @scale_y then translating by @offset_x and @offset_y.
This gives an image in the coordinates of the destination pixbuf.
The rectangle (@dest_x, @dest_y, @dest_width, @dest_height)
is then composited onto the corresponding rectangle of the
original destination image.

When the destination rectangle contains parts not in the source 
image, the data at the edges of the source image is replicated
to infinity. 

&lt;figure id=&quot;pixbuf-composite-diagram&quot;&gt;
&lt;title&gt;Compositing of pixbufs&lt;/title&gt;
&lt;graphic fileref=&quot;composite.png&quot; format=&quot;PNG&quot;/&gt;
&lt;/figure&gt;

</description>
<parameters>
<parameter name="src">
<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
<parameter name="dest">
<parameter_description> the #GdkPixbuf into which to render the results
</parameter_description>
</parameter>
<parameter name="dest_x">
<parameter_description> the left coordinate for region to render
</parameter_description>
</parameter>
<parameter name="dest_y">
<parameter_description> the top coordinate for region to render
</parameter_description>
</parameter>
<parameter name="dest_width">
<parameter_description> the width of the region to render
</parameter_description>
</parameter>
<parameter name="dest_height">
<parameter_description> the height of the region to render
</parameter_description>
</parameter>
<parameter name="offset_x">
<parameter_description> the offset in the X direction (currently rounded to an integer)
</parameter_description>
</parameter>
<parameter name="offset_y">
<parameter_description> the offset in the Y direction (currently rounded to an integer)
</parameter_description>
</parameter>
<parameter name="scale_x">
<parameter_description> the scale factor in the X direction
</parameter_description>
</parameter>
<parameter name="scale_y">
<parameter_description> the scale factor in the Y direction
</parameter_description>
</parameter>
<parameter name="interp_type">
<parameter_description> the interpolation type for the transformation.
</parameter_description>
</parameter>
<parameter name="overall_alpha">
<parameter_description> overall alpha for source image (0..255)
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_pixbuf_composite_color">
<description>
Creates a transformation of the source image @src by scaling by
@scale_x and @scale_y then translating by @offset_x and @offset_y,
then composites the rectangle (@dest_x ,@dest_y, @dest_width,
@dest_height) of the resulting image with a checkboard of the
colors @color1 and @color2 and renders it onto the destination
image.

See gdk_pixbuf_composite_color_simple() for a simpler variant of this
function suitable for many tasks.


</description>
<parameters>
<parameter name="src">
<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
<parameter name="dest">
<parameter_description> the #GdkPixbuf into which to render the results
</parameter_description>
</parameter>
<parameter name="dest_x">
<parameter_description> the left coordinate for region to render
</parameter_description>
</parameter>
<parameter name="dest_y">
<parameter_description> the top coordinate for region to render
</parameter_description>
</parameter>
<parameter name="dest_width">
<parameter_description> the width of the region to render
</parameter_description>
</parameter>
<parameter name="dest_height">
<parameter_description> the height of the region to render
</parameter_description>
</parameter>
<parameter name="offset_x">
<parameter_description> the offset in the X direction (currently rounded to an integer)
</parameter_description>
</parameter>
<parameter name="offset_y">
<parameter_description> the offset in the Y direction (currently rounded to an integer)
</parameter_description>
</parameter>
<parameter name="scale_x">
<parameter_description> the scale factor in the X direction
</parameter_description>
</parameter>
<parameter name="scale_y">
<parameter_description> the scale factor in the Y direction
</parameter_description>
</parameter>
<parameter name="interp_type">
<parameter_description> the interpolation type for the transformation.
</parameter_description>
</parameter>
<parameter name="overall_alpha">
<parameter_description> overall alpha for source image (0..255)
</parameter_description>
</parameter>
<parameter name="check_x">
<parameter_description> the X offset for the checkboard (origin of checkboard is at -@check_x, -@check_y)
</parameter_description>
</parameter>
<parameter name="check_y">
<parameter_description> the Y offset for the checkboard 
</parameter_description>
</parameter>
<parameter name="check_size">
<parameter_description> the size of checks in the checkboard (must be a power of two)
</parameter_description>
</parameter>
<parameter name="color1">
<parameter_description> the color of check at upper left
</parameter_description>
</parameter>
<parameter name="color2">
<parameter_description> the color of the other check
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_pixbuf_composite_color_simple">
<description>
Creates a new #GdkPixbuf by scaling @src to @dest_width x
@dest_height and compositing the result with a checkboard of colors
@color1 and @color2.


</description>
<parameters>
<parameter name="src">
<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
<parameter name="dest_width">
<parameter_description> the width of destination image
</parameter_description>
</parameter>
<parameter name="dest_height">
<parameter_description> the height of destination image
</parameter_description>
</parameter>
<parameter name="interp_type">
<parameter_description> the interpolation type for the transformation.
</parameter_description>
</parameter>
<parameter name="overall_alpha">
<parameter_description> overall alpha for source image (0..255)
</parameter_description>
</parameter>
<parameter name="check_size">
<parameter_description> the size of checks in the checkboard (must be a power of two)
</parameter_description>
</parameter>
<parameter name="color1">
<parameter_description> the color of check at upper left
</parameter_description>
</parameter>
<parameter name="color2">
<parameter_description> the color of the other check
</parameter_description>
</parameter>
</parameters>
<return> the new #GdkPixbuf, or %NULL if not enough memory could be
allocated for it.
</return>
</function>

<function name="gdk_pixbuf_copy">
<description>
Creates a new #GdkPixbuf with a copy of the information in the specified
@pixbuf.


</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> A pixbuf.
</parameter_description>
</parameter>
</parameters>
<return> A newly-created pixbuf with a reference count of 1, or %NULL if
not enough memory could be allocated.
</return>
</function>

<function name="gdk_pixbuf_copy_area">
<description>
Copies a rectangular area from @src_pixbuf to @dest_pixbuf.  Conversion of
pixbuf formats is done automatically.

If the source rectangle overlaps the destination rectangle on the
same pixbuf, it will be overwritten during the copy operation.
Therefore, you can not use this function to scroll a pixbuf.

</description>
<parameters>
<parameter name="src_pixbuf">
<parameter_description> Source pixbuf.
</parameter_description>
</parameter>
<parameter name="src_x">
<parameter_description> Source X coordinate within @src_pixbuf.
</parameter_description>
</parameter>
<parameter name="src_y">
<parameter_description> Source Y coordinate within @src_pixbuf.
</parameter_description>
</parameter>
<parameter name="width">
<parameter_description> Width of the area to copy.
</parameter_description>
</parameter>
<parameter name="height">
<parameter_description> Height of the area to copy.
</parameter_description>
</parameter>
<parameter name="dest_pixbuf">
<parameter_description> Destination pixbuf.
</parameter_description>
</parameter>
<parameter name="dest_x">
<parameter_description> X coordinate within @dest_pixbuf.
</parameter_description>
</parameter>
<parameter name="dest_y">
<parameter_description> Y coordinate within @dest_pixbuf.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_pixbuf_fill">
<description>
Clears a pixbuf to the given RGBA value, converting the RGBA value into
the pixbuf's pixel format. The alpha will be ignored if the pixbuf
doesn't have an alpha channel.


</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
<parameter name="pixel">
<parameter_description> RGBA pixel to clear to
(0xffffffff is opaque white, 0x00000000 transparent black)
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_pixbuf_flip">
<description>
Flips a pixbuf horizontally or vertically and returns the
result in a new pixbuf.

Since: 2.6

</description>
<parameters>
<parameter name="src">
<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
<parameter name="horizontal">
<parameter_description> %TRUE to flip horizontally, %FALSE to flip vertically
</parameter_description>
</parameter>
</parameters>
<return> the new #GdkPixbuf, or %NULL if not enough memory could be
allocated for it.

</return>
</function>

<function name="gdk_pixbuf_format_copy">
<description>
Creates a copy of @format

Since: 2.22

</description>
<parameters>
<parameter name="format">
<parameter_description> a #GdkPixbufFormat
</parameter_description>
</parameter>
</parameters>
<return> the newly allocated copy of a #GdkPixbufFormat. Use
gdk_pixbuf_format_free() to free the resources when done

</return>
</function>

<function name="gdk_pixbuf_format_free">
<description>
Frees the resources allocated when copying a #GdkPixbufFormat
using gdk_pixbuf_format_copy()

Since: 2.22

</description>
<parameters>
<parameter name="format">
<parameter_description> a #GdkPixbufFormat
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_pixbuf_format_get_description">
<description>
Returns a description of the format.

Since: 2.2

</description>
<parameters>
<parameter name="format">
<parameter_description> a #GdkPixbufFormat
</parameter_description>
</parameter>
</parameters>
<return> a description of the format.

</return>
</function>

<function name="gdk_pixbuf_format_get_extensions">
<description>
Returns the filename extensions typically used for files in the 
given format.

Since: 2.2

</description>
<parameters>
<parameter name="format">
<parameter_description> a #GdkPixbufFormat
</parameter_description>
</parameter>
</parameters>
<return> a %NULL-terminated array of filename extensions which must be
freed with g_strfreev() when it is no longer needed.

</return>
</function>

<function name="gdk_pixbuf_format_get_license">
<description>
Returns information about the license of the image loader for the format. The
returned string should be a shorthand for a wellknown license, e.g. &quot;LGPL&quot;,
&quot;GPL&quot;, &quot;QPL&quot;, &quot;GPL/QPL&quot;, or &quot;other&quot; to indicate some other license.  This
string should be freed with g_free() when it's no longer needed.

Since: 2.6

</description>
<parameters>
<parameter name="format">
<parameter_description> a #GdkPixbufFormat
</parameter_description>
</parameter>
</parameters>
<return> a string describing the license of @format. 

</return>
</function>

<function name="gdk_pixbuf_format_get_mime_types">
<description>
Returns the mime types supported by the format.

Since: 2.2

</description>
<parameters>
<parameter name="format">
<parameter_description> a #GdkPixbufFormat
</parameter_description>
</parameter>
</parameters>
<return> a %NULL-terminated array of mime types which must be freed with 
g_strfreev() when it is no longer needed.

</return>
</function>

<function name="gdk_pixbuf_format_get_name">
<description>
Returns the name of the format.

Since: 2.2

</description>
<parameters>
<parameter name="format">
<parameter_description> a #GdkPixbufFormat
</parameter_description>
</parameter>
</parameters>
<return> the name of the format. 

</return>
</function>

<function name="gdk_pixbuf_format_is_disabled">
<description>
Returns whether this image format is disabled. See
gdk_pixbuf_format_set_disabled().

Since: 2.6

</description>
<parameters>
<parameter name="format">
<parameter_description> a #GdkPixbufFormat
</parameter_description>
</parameter>
</parameters>
<return> whether this image format is disabled.

</return>
</function>

<function name="gdk_pixbuf_format_is_scalable">
<description>
Returns whether this image format is scalable. If a file is in a 
scalable format, it is preferable to load it at the desired size, 
rather than loading it at the default size and scaling the 
resulting pixbuf to the desired size.

Since: 2.6

</description>
<parameters>
<parameter name="format">
<parameter_description> a #GdkPixbufFormat
</parameter_description>
</parameter>
</parameters>
<return> whether this image format is scalable.

</return>
</function>

<function name="gdk_pixbuf_format_is_writable">
<description>
Returns whether pixbufs can be saved in the given format.

Since: 2.2

</description>
<parameters>
<parameter name="format">
<parameter_description> a #GdkPixbufFormat
</parameter_description>
</parameter>
</parameters>
<return> whether pixbufs can be saved in the given format.

</return>
</function>

<function name="gdk_pixbuf_format_set_disabled">
<description>
Disables or enables an image format. If a format is disabled, 
gdk-pixbuf won't use the image loader for this format to load 
images. Applications can use this to avoid using image loaders 
with an inappropriate license, see gdk_pixbuf_format_get_license().

Since: 2.6

</description>
<parameters>
<parameter name="format">
<parameter_description> a #GdkPixbufFormat
</parameter_description>
</parameter>
<parameter name="disabled">
<parameter_description> %TRUE to disable the format @format
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_pixbuf_from_pixdata">
<description>
Converts a #GdkPixdata to a #GdkPixbuf. If @copy_pixels is %TRUE or
if the pixel data is run-length-encoded, the pixel data is copied into
newly-allocated memory; otherwise it is reused.


</description>
<parameters>
<parameter name="pixdata">
<parameter_description> a #GdkPixdata to convert into a #GdkPixbuf.
</parameter_description>
</parameter>
<parameter name="copy_pixels">
<parameter_description> whether to copy raw pixel data; run-length encoded
pixel data is always copied.
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> location to store possible errors.
</parameter_description>
</parameter>
</parameters>
<return> a new #GdkPixbuf.
</return>
</function>

<function name="gdk_pixbuf_get_bits_per_sample">
<description>
Queries the number of bits per color sample in a pixbuf.


</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> A pixbuf.
</parameter_description>
</parameter>
</parameters>
<return> Number of bits per color sample.
</return>
</function>

<function name="gdk_pixbuf_get_byte_length">
<description>
Returns the length of the pixel data, in bytes.

Since: 2.26

</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> A pixbuf
</parameter_description>
</parameter>
</parameters>
<return> The length of the pixel data.

</return>
</function>

<function name="gdk_pixbuf_get_colorspace">
<description>
Queries the color space of a pixbuf.


</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> A pixbuf.
</parameter_description>
</parameter>
</parameters>
<return> Color space.
</return>
</function>

<function name="gdk_pixbuf_get_file_info">
<description>
Parses an image file far enough to determine its format and size.

Since: 2.4

</description>
<parameters>
<parameter name="filename">
<parameter_description> The name of the file to identify.
</parameter_description>
</parameter>
<parameter name="width">
<parameter_description> Return location for the width of the image, or %NULL
</parameter_description>
</parameter>
<parameter name="height">
<parameter_description> Return location for the height of the image, or %NULL
</parameter_description>
</parameter>
</parameters>
<return> A #GdkPixbufFormat describing the image
format of the file or %NULL if the image format wasn't
recognized. The return value is owned by GdkPixbuf and should
not be freed.

</return>
</function>

<function name="gdk_pixbuf_get_formats">
<description>
Obtains the available information about the image formats supported
by GdkPixbuf.

Since: 2.2

</description>
<parameters>
</parameters>
<return> A list of
#GdkPixbufFormat&lt;!-- --&gt;s describing the supported
image formats.  The list should be freed when it is no longer needed,
but the structures themselves are owned by #GdkPixbuf and should not be
freed.

</return>
</function>

<function name="gdk_pixbuf_get_from_surface">
<description>
Transfers image data from a #cairo_surface_t and converts it to an RGB(A)
representation inside a #GdkPixbuf. This allows you to efficiently read
individual pixels from cairo surfaces. For #GdkWindows, use
gdk_pixbuf_get_from_window() instead.

This function will create an RGB pixbuf with 8 bits per channel.
The pixbuf will contain an alpha channel if the @surface contains one.


</description>
<parameters>
<parameter name="surface">
<parameter_description> surface to copy from
</parameter_description>
</parameter>
<parameter name="src_x">
<parameter_description> Source X coordinate within @surface
</parameter_description>
</parameter>
<parameter name="src_y">
<parameter_description> Source Y coordinate within @surface
</parameter_description>
</parameter>
<parameter name="width">
<parameter_description> Width in pixels of region to get
</parameter_description>
</parameter>
<parameter name="height">
<parameter_description> Height in pixels of region to get
</parameter_description>
</parameter>
</parameters>
<return> A newly-created pixbuf with a reference
count of 1, or %NULL on error
</return>
</function>

<function name="gdk_pixbuf_get_from_window">
<description>
Transfers image data from a #GdkWindow and converts it to an RGB(A)
representation inside a #GdkPixbuf. In other words, copies
image data from a server-side drawable to a client-side RGB(A) buffer.
This allows you to efficiently read individual pixels on the client side.

This function will create an RGB pixbuf with 8 bits per channel with
the same size specified by the @width and @height arguments. The pixbuf
will contain an alpha channel if the @window contains one.

If the window is off the screen, then there is no image data in the
obscured/offscreen regions to be placed in the pixbuf. The contents of
portions of the pixbuf corresponding to the offscreen region are undefined.

If the window you're obtaining data from is partially obscured by
other windows, then the contents of the pixbuf areas corresponding
to the obscured regions are undefined.

If the window is not mapped (typically because it's iconified/minimized
or not on the current workspace), then %NULL will be returned.

If memory can't be allocated for the return value, %NULL will be returned
instead.

(In short, there are several ways this function can fail, and if it fails
it returns %NULL; so check the return value.)


</description>
<parameters>
<parameter name="window">
<parameter_description> Source window
</parameter_description>
</parameter>
<parameter name="src_x">
<parameter_description> Source X coordinate within @window
</parameter_description>
</parameter>
<parameter name="src_y">
<parameter_description> Source Y coordinate within @window
</parameter_description>
</parameter>
<parameter name="width">
<parameter_description> Width in pixels of region to get
</parameter_description>
</parameter>
<parameter name="height">
<parameter_description> Height in pixels of region to get
</parameter_description>
</parameter>
</parameters>
<return> A newly-created pixbuf with a reference
count of 1, or %NULL on error
</return>
</function>

<function name="gdk_pixbuf_get_has_alpha">
<description>
Queries whether a pixbuf has an alpha channel (opacity information).


</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> A pixbuf.
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if it has an alpha channel, %FALSE otherwise.
</return>
</function>

<function name="gdk_pixbuf_get_height">
<description>
Queries the height of a pixbuf.


</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> A pixbuf.
</parameter_description>
</parameter>
</parameters>
<return> Height in pixels.
</return>
</function>

<function name="gdk_pixbuf_get_n_channels">
<description>
Queries the number of channels of a pixbuf.


</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> A pixbuf.
</parameter_description>
</parameter>
</parameters>
<return> Number of channels.
</return>
</function>

<function name="gdk_pixbuf_get_option">
<description>
Looks up @key in the list of options that may have been attached to the
@pixbuf when it was loaded, or that may have been attached by another
function using gdk_pixbuf_set_option().

For instance, the ANI loader provides &quot;Title&quot; and &quot;Artist&quot; options. 
The ICO, XBM, and XPM loaders provide &quot;x_hot&quot; and &quot;y_hot&quot; hot-spot 
options for cursor definitions. The PNG loader provides the tEXt ancillary
chunk key/value pairs as options. Since 2.12, the TIFF and JPEG loaders
return an &quot;orientation&quot; option string that corresponds to the embedded 
TIFF/Exif orientation tag (if present).


</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
<parameter name="key">
<parameter_description> a nul-terminated string.
</parameter_description>
</parameter>
</parameters>
<return> the value associated with @key. This is a nul-terminated 
string that should not be freed or %NULL if @key was not found.
</return>
</function>

<function name="gdk_pixbuf_get_pixels">
<description>
Queries a pointer to the pixel data of a pixbuf.


</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> A pixbuf.
</parameter_description>
</parameter>
</parameters>
<return> A pointer to the pixbuf's pixel data.
Please see &lt;xref linkend=&quot;image-data&quot;/&gt; for information about how
the pixel data is stored in memory.
</return>
</function>

<function name="gdk_pixbuf_get_pixels_with_length">
<description>
Queries a pointer to the pixel data of a pixbuf.

Since: 2.26

</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> A pixbuf.
</parameter_description>
</parameter>
<parameter name="length">
<parameter_description> The length of the binary data.
</parameter_description>
</parameter>
</parameters>
<return> A pointer to the pixbuf's
pixel data.  Please see &lt;xref linkend=&quot;image-data&quot;/&gt;
for information about how the pixel data is stored in
memory.

</return>
</function>

<function name="gdk_pixbuf_get_rowstride">
<description>
Queries the rowstride of a pixbuf, which is the number of bytes between the start of a row
and the start of the next row.


</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> A pixbuf.
</parameter_description>
</parameter>
</parameters>
<return> Distance between row starts.
</return>
</function>

<function name="gdk_pixbuf_get_width">
<description>
Queries the width of a pixbuf.


</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> A pixbuf.
</parameter_description>
</parameter>
</parameters>
<return> Width in pixels.
</return>
</function>

<function name="gdk_pixbuf_loader_close">
<description>
Informs a pixbuf loader that no further writes with
gdk_pixbuf_loader_write() will occur, so that it can free its
internal loading structures. Also, tries to parse any data that
hasn't yet been parsed; if the remaining data is partial or
corrupt, an error will be returned.  If %FALSE is returned, @error
will be set to an error from the #GDK_PIXBUF_ERROR or #G_FILE_ERROR
domains. If you're just cancelling a load rather than expecting it
to be finished, passing %NULL for @error to ignore it is
reasonable.

Remember that this does not unref the loader, so if you plan not to
use it anymore, please g_object_unref() it.


</description>
<parameters>
<parameter name="loader">
<parameter_description> A pixbuf loader.
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> return location for a #GError, or %NULL to ignore errors
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if all image data written so far was successfully
            passed out via the update_area signal
</return>
</function>

<function name="gdk_pixbuf_loader_get_animation">
<description>
Queries the #GdkPixbufAnimation that a pixbuf loader is currently creating.
In general it only makes sense to call this function after the &quot;area-prepared&quot;
signal has been emitted by the loader. If the loader doesn't have enough
bytes yet (hasn't emitted the &quot;area-prepared&quot; signal) this function will 
return %NULL.


</description>
<parameters>
<parameter name="loader">
<parameter_description> A pixbuf loader
</parameter_description>
</parameter>
</parameters>
<return> The #GdkPixbufAnimation that the loader is loading, or %NULL if
 not enough data has been read to determine the information.
</return>
</function>

<function name="gdk_pixbuf_loader_get_format">
<description>
Obtains the available information about the format of the 
currently loading image file.

Since: 2.2

</description>
<parameters>
<parameter name="loader">
<parameter_description> A pixbuf loader.
</parameter_description>
</parameter>
</parameters>
<return> A #GdkPixbufFormat or %NULL. The return
value is owned by GdkPixbuf and should not be freed.

</return>
</function>

<function name="gdk_pixbuf_loader_get_pixbuf">
<description>
Queries the #GdkPixbuf that a pixbuf loader is currently creating.
In general it only makes sense to call this function after the
&quot;area-prepared&quot; signal has been emitted by the loader; this means
that enough data has been read to know the size of the image that
will be allocated.  If the loader has not received enough data via
gdk_pixbuf_loader_write(), then this function returns %NULL.  The
returned pixbuf will be the same in all future calls to the loader,
so simply calling g_object_ref() should be sufficient to continue
using it.  Additionally, if the loader is an animation, it will
return the &quot;static image&quot; of the animation
(see gdk_pixbuf_animation_get_static_image()).


</description>
<parameters>
<parameter name="loader">
<parameter_description> A pixbuf loader.
</parameter_description>
</parameter>
</parameters>
<return> The #GdkPixbuf that the loader is creating, or %NULL if not
enough data has been read to determine how to create the image buffer.
</return>
</function>

<function name="gdk_pixbuf_loader_new">
<description>
Creates a new pixbuf loader object.


</description>
<parameters>
</parameters>
<return> A newly-created pixbuf loader.
</return>
</function>

<function name="gdk_pixbuf_loader_new_with_mime_type">
<description>
Creates a new pixbuf loader object that always attempts to parse
image data as if it were an image of mime type @mime_type, instead of
identifying the type automatically. Useful if you want an error if
the image isn't the expected mime type, for loading image formats
that can't be reliably identified by looking at the data, or if
the user manually forces a specific mime type.

The list of supported mime types depends on what image loaders
are installed, but typically &quot;image/png&quot;, &quot;image/jpeg&quot;, &quot;image/gif&quot;, 
&quot;image/tiff&quot; and &quot;image/x-xpixmap&quot; are among the supported mime types. 
To obtain the full list of supported mime types, call 
gdk_pixbuf_format_get_mime_types() on each of the #GdkPixbufFormat 
structs returned by gdk_pixbuf_get_formats().

Since: 2.4

</description>
<parameters>
<parameter name="mime_type">
<parameter_description> the mime type to be loaded 
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> return location for an allocated #GError, or %NULL to ignore errors
</parameter_description>
</parameter>
</parameters>
<return> A newly-created pixbuf loader.
</return>
</function>

<function name="gdk_pixbuf_loader_new_with_type">
<description>
Creates a new pixbuf loader object that always attempts to parse
image data as if it were an image of type @image_type, instead of
identifying the type automatically. Useful if you want an error if
the image isn't the expected type, for loading image formats
that can't be reliably identified by looking at the data, or if
the user manually forces a specific type.

The list of supported image formats depends on what image loaders
are installed, but typically &quot;png&quot;, &quot;jpeg&quot;, &quot;gif&quot;, &quot;tiff&quot; and 
&quot;xpm&quot; are among the supported formats. To obtain the full list of
supported image formats, call gdk_pixbuf_format_get_name() on each 
of the #GdkPixbufFormat structs returned by gdk_pixbuf_get_formats().


</description>
<parameters>
<parameter name="image_type">
<parameter_description> name of the image format to be loaded with the image
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> return location for an allocated #GError, or %NULL to ignore errors
</parameter_description>
</parameter>
</parameters>
<return> A newly-created pixbuf loader.
</return>
</function>

<function name="gdk_pixbuf_loader_set_size">
<description>
Causes the image to be scaled while it is loaded. The desired
image size can be determined relative to the original size of
the image by calling gdk_pixbuf_loader_set_size() from a
signal handler for the ::size-prepared signal.

Attempts to set the desired image size  are ignored after the 
emission of the ::size-prepared signal.

Since: 2.2

</description>
<parameters>
<parameter name="loader">
<parameter_description> A pixbuf loader.
</parameter_description>
</parameter>
<parameter name="width">
<parameter_description> The desired width of the image being loaded.
</parameter_description>
</parameter>
<parameter name="height">
<parameter_description> The desired height of the image being loaded.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_pixbuf_loader_write">
<description>
This will cause a pixbuf loader to parse the next @count bytes of
an image.  It will return %TRUE if the data was loaded successfully,
and %FALSE if an error occurred.  In the latter case, the loader
will be closed, and will not accept further writes. If %FALSE is
returned, @error will be set to an error from the #GDK_PIXBUF_ERROR
or #G_FILE_ERROR domains.


</description>
<parameters>
<parameter name="loader">
<parameter_description> A pixbuf loader.
</parameter_description>
</parameter>
<parameter name="buf">
<parameter_description> Pointer to image data.
</parameter_description>
</parameter>
<parameter name="count">
<parameter_description> Length of the @buf buffer in bytes.
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> return location for errors
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the write was successful, or %FALSE if the loader
cannot parse the buffer.
</return>
</function>

<function name="gdk_pixbuf_major_version">
<description>
The major version number of the &amp;gdk-pixbuf; library.  (e.g. in 
&amp;gdk-pixbuf; version 1.2.5 this is 1.) 


This variable is in the library, so represents the
&amp;gdk-pixbuf; library you have linked against. Contrast with the
#GDK_PIXBUF_MAJOR macro, which represents the major version of the
&amp;gdk-pixbuf; headers you have included.

</description>
<parameters>
</parameters>
<return></return>
</function>

<function name="gdk_pixbuf_micro_version">
<description>
The micro version number of the &amp;gdk-pixbuf; library.  (e.g. in 
&amp;gdk-pixbuf; version 1.2.5 this is 5.) 


This variable is in the library, so represents the
&amp;gdk-pixbuf; library you have linked against. Contrast with the
#GDK_PIXBUF_MICRO macro, which represents the micro version of the
&amp;gdk-pixbuf; headers you have included.

</description>
<parameters>
</parameters>
<return></return>
</function>

<function name="gdk_pixbuf_minor_version">
<description>
The minor version number of the &amp;gdk-pixbuf; library.  (e.g. in 
&amp;gdk-pixbuf; version 1.2.5 this is 2.) 


This variable is in the library, so represents the
&amp;gdk-pixbuf; library you have linked against. Contrast with the
#GDK_PIXBUF_MINOR macro, which represents the minor version of the
&amp;gdk-pixbuf; headers you have included.

</description>
<parameters>
</parameters>
<return></return>
</function>

<function name="gdk_pixbuf_new">
<description>
Creates a new #GdkPixbuf structure and allocates a buffer for it.  The 
buffer has an optimal rowstride.  Note that the buffer is not cleared;
you will have to fill it completely yourself.


</description>
<parameters>
<parameter name="colorspace">
<parameter_description> Color space for image
</parameter_description>
</parameter>
<parameter name="has_alpha">
<parameter_description> Whether the image should have transparency information
</parameter_description>
</parameter>
<parameter name="bits_per_sample">
<parameter_description> Number of bits per color sample
</parameter_description>
</parameter>
<parameter name="width">
<parameter_description> Width of image in pixels, must be &gt; 0
</parameter_description>
</parameter>
<parameter name="height">
<parameter_description> Height of image in pixels, must be &gt; 0
</parameter_description>
</parameter>
</parameters>
<return> A newly-created #GdkPixbuf with a reference count of 1, or 
%NULL if not enough memory could be allocated for the image buffer.
</return>
</function>

<function name="gdk_pixbuf_new_from_data">
<description>
Creates a new #GdkPixbuf out of in-memory image data.  Currently only RGB
images with 8 bits per sample are supported.


</description>
<parameters>
<parameter name="data">
<parameter_description> Image data in 8-bit/sample packed format
</parameter_description>
</parameter>
<parameter name="colorspace">
<parameter_description> Colorspace for the image data
</parameter_description>
</parameter>
<parameter name="has_alpha">
<parameter_description> Whether the data has an opacity channel
</parameter_description>
</parameter>
<parameter name="bits_per_sample">
<parameter_description> Number of bits per sample
</parameter_description>
</parameter>
<parameter name="width">
<parameter_description> Width of the image in pixels, must be &gt; 0
</parameter_description>
</parameter>
<parameter name="height">
<parameter_description> Height of the image in pixels, must be &gt; 0
</parameter_description>
</parameter>
<parameter name="rowstride">
<parameter_description> Distance in bytes between row starts
</parameter_description>
</parameter>
<parameter name="destroy_fn">
<parameter_description> Function used to free the data when the pixbuf's reference count
drops to zero, or %NULL if the data should not be freed
</parameter_description>
</parameter>
<parameter name="destroy_fn_data">
<parameter_description> Closure data to pass to the destroy notification function
</parameter_description>
</parameter>
</parameters>
<return> A newly-created #GdkPixbuf structure with a reference count of 1.
</return>
</function>

<function name="gdk_pixbuf_new_from_file">
<description>
Creates a new pixbuf by loading an image from a file.  The file format is
detected automatically. If %NULL is returned, then @error will be set.
Possible errors are in the #GDK_PIXBUF_ERROR and #G_FILE_ERROR domains.


</description>
<parameters>
<parameter name="filename">
<parameter_description> Name of file to load, in the GLib file name encoding
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> Return location for an error
</parameter_description>
</parameter>
</parameters>
<return> A newly-created pixbuf with a reference count of 1, or %NULL if
any of several error conditions occurred:  the file could not be opened,
there was no loader for the file's format, there was not enough memory to
allocate the image buffer, or the image file contained invalid data.
</return>
</function>

<function name="gdk_pixbuf_new_from_file_at_scale">
<description>
Creates a new pixbuf by loading an image from a file.  The file format is
detected automatically. If %NULL is returned, then @error will be set.
Possible errors are in the #GDK_PIXBUF_ERROR and #G_FILE_ERROR domains.
The image will be scaled to fit in the requested size, optionally preserving
the image's aspect ratio. 

When preserving the aspect ratio, a @width of -1 will cause the image
to be scaled to the exact given height, and a @height of -1 will cause
the image to be scaled to the exact given width. When not preserving
aspect ratio, a @width or @height of -1 means to not scale the image 
at all in that dimension. Negative values for @width and @height are 
allowed since 2.8.

Since: 2.6

</description>
<parameters>
<parameter name="filename">
<parameter_description> Name of file to load, in the GLib file name encoding
</parameter_description>
</parameter>
<parameter name="width">
<parameter_description> The width the image should have or -1 to not constrain the width
</parameter_description>
</parameter>
<parameter name="height">
<parameter_description> The height the image should have or -1 to not constrain the height
</parameter_description>
</parameter>
<parameter name="preserve_aspect_ratio">
<parameter_description> %TRUE to preserve the image's aspect ratio
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> Return location for an error
</parameter_description>
</parameter>
</parameters>
<return> A newly-created pixbuf with a reference count of 1, or %NULL 
if any of several error conditions occurred:  the file could not be opened,
there was no loader for the file's format, there was not enough memory to
allocate the image buffer, or the image file contained invalid data.

</return>
</function>

<function name="gdk_pixbuf_new_from_file_at_size">
<description>
Creates a new pixbuf by loading an image from a file.  
The file format is detected automatically. If %NULL is returned, then 
@error will be set. Possible errors are in the #GDK_PIXBUF_ERROR and 
#G_FILE_ERROR domains.

The image will be scaled to fit in the requested size, preserving
the image's aspect ratio. Note that the returned pixbuf may be smaller
than @width x @height, if the aspect ratio requires it. To load
and image at the requested size, regardless of aspect ratio, use
gdk_pixbuf_new_from_file_at_scale().

Since: 2.4

</description>
<parameters>
<parameter name="filename">
<parameter_description> Name of file to load, in the GLib file name encoding
</parameter_description>
</parameter>
<parameter name="width">
<parameter_description> The width the image should have or -1 to not constrain the width
</parameter_description>
</parameter>
<parameter name="height">
<parameter_description> The height the image should have or -1 to not constrain the height
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> Return location for an error
</parameter_description>
</parameter>
</parameters>
<return> A newly-created pixbuf with a reference count of 1, or 
%NULL if any of several error conditions occurred:  the file could not 
be opened, there was no loader for the file's format, there was not 
enough memory to allocate the image buffer, or the image file contained 
invalid data.

</return>
</function>

<function name="gdk_pixbuf_new_from_inline">
<description>
Create a #GdkPixbuf from a flat representation that is suitable for
storing as inline data in a program. This is useful if you want to
ship a program with images, but don't want to depend on any
external files.

gdk-pixbuf ships with a program called &lt;command&gt;gdk-pixbuf-csource&lt;/command&gt; 
which allows for conversion of #GdkPixbufs into such a inline representation.
In almost all cases, you should pass the &lt;option&gt;--raw&lt;/option&gt; flag to
&lt;command&gt;gdk-pixbuf-csource&lt;/command&gt;. A sample invocation would be:

&lt;informalexample&gt;&lt;programlisting&gt;
gdk-pixbuf-csource --raw --name=myimage_inline myimage.png
&lt;/programlisting&gt;&lt;/informalexample&gt;

For the typical case where the inline pixbuf is read-only static data,
you don't need to copy the pixel data unless you intend to write to
it, so you can pass %FALSE for @copy_pixels.  (If you pass 
&lt;option&gt;--rle&lt;/option&gt; to &lt;command&gt;gdk-pixbuf-csource&lt;/command&gt;, a copy 
will be made even if @copy_pixels is %FALSE, so using this option is 
generally a bad idea.)

If you create a pixbuf from const inline data compiled into your
program, it's probably safe to ignore errors and disable length checks, 
since things will always succeed:
&lt;informalexample&gt;&lt;programlisting&gt;
pixbuf = gdk_pixbuf_new_from_inline (-1, myimage_inline, FALSE, NULL);
&lt;/programlisting&gt;&lt;/informalexample&gt;

For non-const inline data, you could get out of memory. For untrusted 
inline data located at runtime, you could have corrupt inline data in 
addition.


</description>
<parameters>
<parameter name="data_length">
<parameter_description> Length in bytes of the @data argument or -1 to 
disable length checks
</parameter_description>
</parameter>
<parameter name="data">
<parameter_description> Byte data containing a
serialized #GdkPixdata structure
</parameter_description>
</parameter>
<parameter name="copy_pixels">
<parameter_description> Whether to copy the pixel data, or use direct pointers
@data for the resulting pixbuf
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> #GError return location, may be %NULL to ignore errors
</parameter_description>
</parameter>
</parameters>
<return> A newly-created #GdkPixbuf structure with a reference,
count of 1, or %NULL if an error occurred.
</return>
</function>

<function name="gdk_pixbuf_new_from_resource">
<description>
Creates a new pixbuf by loading an image from an resource.

The file format is detected automatically. If %NULL is returned, then
@error will be set.

Since: 2.26

</description>
<parameters>
<parameter name="resource_path">
<parameter_description> the path of the resource file
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> Return location for an error
</parameter_description>
</parameter>
</parameters>
<return> A newly-created pixbuf, or %NULL if any of several error
conditions occurred: the file could not be opened, the image format is
not supported, there was not enough memory to allocate the image buffer,
the stream contained invalid data, or the operation was cancelled.

</return>
</function>

<function name="gdk_pixbuf_new_from_resource_at_scale">
<description>
Creates a new pixbuf by loading an image from an resource.

The file format is detected automatically. If %NULL is returned, then
@error will be set.

The image will be scaled to fit in the requested size, optionally
preserving the image's aspect ratio. When preserving the aspect ratio,
a @width of -1 will cause the image to be scaled to the exact given
height, and a @height of -1 will cause the image to be scaled to the
exact given width. When not preserving aspect ratio, a @width or
@height of -1 means to not scale the image at all in that dimension.

The stream is not closed.

Since: 2.26

</description>
<parameters>
<parameter name="resource_path">
<parameter_description> the path of the resource file
</parameter_description>
</parameter>
<parameter name="width">
<parameter_description> The width the image should have or -1 to not constrain the width
</parameter_description>
</parameter>
<parameter name="height">
<parameter_description> The height the image should have or -1 to not constrain the height
</parameter_description>
</parameter>
<parameter name="preserve_aspect_ratio">
<parameter_description> %TRUE to preserve the image's aspect ratio
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> Return location for an error
</parameter_description>
</parameter>
</parameters>
<return> A newly-created pixbuf, or %NULL if any of several error
conditions occurred: the file could not be opened, the image format is
not supported, there was not enough memory to allocate the image buffer,
the stream contained invalid data, or the operation was cancelled.

</return>
</function>

<function name="gdk_pixbuf_new_from_stream">
<description>
Creates a new pixbuf by loading an image from an input stream.  

The file format is detected automatically. If %NULL is returned, then 
@error will be set. The @cancellable can be used to abort the operation
from another thread. If the operation was cancelled, the error 
%G_IO_ERROR_CANCELLED will be returned. Other possible errors are in 
the #GDK_PIXBUF_ERROR and %G_IO_ERROR domains. 

The stream is not closed.

Since: 2.14

</description>
<parameters>
<parameter name="stream">
<parameter_description>  a #GInputStream to load the pixbuf from
</parameter_description>
</parameter>
<parameter name="cancellable">
<parameter_description> optional #GCancellable object, %NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> Return location for an error
</parameter_description>
</parameter>
</parameters>
<return> A newly-created pixbuf, or %NULL if any of several error 
conditions occurred: the file could not be opened, the image format is 
not supported, there was not enough memory to allocate the image buffer, 
the stream contained invalid data, or the operation was cancelled.

</return>
</function>

<function name="gdk_pixbuf_new_from_stream_async">
<description>
Creates a new pixbuf by asynchronously loading an image from an input stream.

For more details see gdk_pixbuf_new_from_stream(), which is the synchronous
version of this function.

When the operation is finished, @callback will be called in the main thread.
You can then call gdk_pixbuf_new_from_stream_finish() to get the result of the operation.

Since: 2.24

</description>
<parameters>
<parameter name="stream">
<parameter_description> a #GInputStream from which to load the pixbuf
</parameter_description>
</parameter>
<parameter name="cancellable">
<parameter_description> optional #GCancellable object, %NULL to ignore
</parameter_description>
</parameter>
<parameter name="callback">
<parameter_description> a #GAsyncReadyCallback to call when the the pixbuf is loaded
</parameter_description>
</parameter>
<parameter name="user_data">
<parameter_description> the data to pass to the callback function
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_pixbuf_new_from_stream_at_scale">
<description>
Creates a new pixbuf by loading an image from an input stream.  

The file format is detected automatically. If %NULL is returned, then 
@error will be set. The @cancellable can be used to abort the operation
from another thread. If the operation was cancelled, the error 
%G_IO_ERROR_CANCELLED will be returned. Other possible errors are in 
the #GDK_PIXBUF_ERROR and %G_IO_ERROR domains. 

The image will be scaled to fit in the requested size, optionally 
preserving the image's aspect ratio. When preserving the aspect ratio, 
a @width of -1 will cause the image to be scaled to the exact given 
height, and a @height of -1 will cause the image to be scaled to the 
exact given width. When not preserving aspect ratio, a @width or 
@height of -1 means to not scale the image at all in that dimension.

The stream is not closed.

Since: 2.14

</description>
<parameters>
<parameter name="stream">
<parameter_description>  a #GInputStream to load the pixbuf from
</parameter_description>
</parameter>
<parameter name="width">
<parameter_description> The width the image should have or -1 to not constrain the width
</parameter_description>
</parameter>
<parameter name="height">
<parameter_description> The height the image should have or -1 to not constrain the height
</parameter_description>
</parameter>
<parameter name="preserve_aspect_ratio">
<parameter_description> %TRUE to preserve the image's aspect ratio
</parameter_description>
</parameter>
<parameter name="cancellable">
<parameter_description> optional #GCancellable object, %NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> Return location for an error
</parameter_description>
</parameter>
</parameters>
<return> A newly-created pixbuf, or %NULL if any of several error 
conditions occurred: the file could not be opened, the image format is 
not supported, there was not enough memory to allocate the image buffer, 
the stream contained invalid data, or the operation was cancelled.

</return>
</function>

<function name="gdk_pixbuf_new_from_stream_at_scale_async">
<description>
Creates a new pixbuf by asynchronously loading an image from an input stream.

For more details see gdk_pixbuf_new_from_stream_at_scale(), which is the synchronous
version of this function.

When the operation is finished, @callback will be called in the main thread.
You can then call gdk_pixbuf_new_from_stream_finish() to get the result of the operation.

Since: 2.24

</description>
<parameters>
<parameter name="stream">
<parameter_description> a #GInputStream from which to load the pixbuf
</parameter_description>
</parameter>
<parameter name="width">
<parameter_description> the width the image should have or -1 to not constrain the width
</parameter_description>
</parameter>
<parameter name="height">
<parameter_description> the height the image should have or -1 to not constrain the height
</parameter_description>
</parameter>
<parameter name="preserve_aspect_ratio">
<parameter_description> %TRUE to preserve the image's aspect ratio
</parameter_description>
</parameter>
<parameter name="cancellable">
<parameter_description> optional #GCancellable object, %NULL to ignore
</parameter_description>
</parameter>
<parameter name="callback">
<parameter_description> a #GAsyncReadyCallback to call when the the pixbuf is loaded
</parameter_description>
</parameter>
<parameter name="user_data">
<parameter_description> the data to pass to the callback function
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_pixbuf_new_from_stream_finish">
<description>
Finishes an asynchronous pixbuf creation operation started with
gdk_pixbuf_new_from_stream_async().

Since: 2.24

</description>
<parameters>
<parameter name="async_result">
<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
<return> a #GdkPixbuf or %NULL on error. Free the returned
object with g_object_unref().

</return>
</function>

<function name="gdk_pixbuf_new_from_xpm_data">
<description>
Creates a new pixbuf by parsing XPM data in memory.  This data is commonly
the result of including an XPM file into a program's C source.


</description>
<parameters>
<parameter name="data">
<parameter_description> Pointer to inline XPM data.
</parameter_description>
</parameter>
</parameters>
<return> A newly-created pixbuf with a reference count of 1.
</return>
</function>

<function name="gdk_pixbuf_new_subpixbuf">
<description>
Creates a new pixbuf which represents a sub-region of
@src_pixbuf. The new pixbuf shares its pixels with the
original pixbuf, so writing to one affects both.
The new pixbuf holds a reference to @src_pixbuf, so
@src_pixbuf will not be finalized until the new pixbuf
is finalized.


</description>
<parameters>
<parameter name="src_pixbuf">
<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
<parameter name="src_x">
<parameter_description> X coord in @src_pixbuf
</parameter_description>
</parameter>
<parameter name="src_y">
<parameter_description> Y coord in @src_pixbuf
</parameter_description>
</parameter>
<parameter name="width">
<parameter_description> width of region in @src_pixbuf
</parameter_description>
</parameter>
<parameter name="height">
<parameter_description> height of region in @src_pixbuf
</parameter_description>
</parameter>
</parameters>
<return> a new pixbuf 
</return>
</function>

<function name="gdk_pixbuf_ref">
<description>
Adds a reference to a pixbuf.

Deprecated: 2.0: Use g_object_ref().

</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> A pixbuf.
</parameter_description>
</parameter>
</parameters>
<return> The same as the @pixbuf argument.

</return>
</function>

<function name="gdk_pixbuf_rotate_simple">
<description>
Rotates a pixbuf by a multiple of 90 degrees, and returns the
result in a new pixbuf.

Since: 2.6

</description>
<parameters>
<parameter name="src">
<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
<parameter name="angle">
<parameter_description> the angle to rotate by
</parameter_description>
</parameter>
</parameters>
<return> the new #GdkPixbuf, or %NULL if not enough memory could be
allocated for it.

</return>
</function>

<function name="gdk_pixbuf_saturate_and_pixelate">
<description>
Modifies saturation and optionally pixelates @src, placing the result in
@dest. @src and @dest may be the same pixbuf with no ill effects.  If
@saturation is 1.0 then saturation is not changed. If it's less than 1.0,
saturation is reduced (the image turns toward grayscale); if greater than
1.0, saturation is increased (the image gets more vivid colors). If @pixelate
is %TRUE, then pixels are faded in a checkerboard pattern to create a
pixelated image. @src and @dest must have the same image format, size, and
rowstride.


</description>
<parameters>
<parameter name="src">
<parameter_description> source image
</parameter_description>
</parameter>
<parameter name="dest">
<parameter_description> place to write modified version of @src
</parameter_description>
</parameter>
<parameter name="saturation">
<parameter_description> saturation factor
</parameter_description>
</parameter>
<parameter name="pixelate">
<parameter_description> whether to pixelate
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_pixbuf_save">
<description>
Saves pixbuf to a file in format @type. By default, &quot;jpeg&quot;, &quot;png&quot;, &quot;ico&quot; 
and &quot;bmp&quot; are possible file formats to save in, but more formats may be
installed. The list of all writable formats can be determined in the 
following way:

|[
void add_if_writable (GdkPixbufFormat *data, GSList **list)
{
if (gdk_pixbuf_format_is_writable (data))
*list = g_slist_prepend (*list, data);
}

GSList *formats = gdk_pixbuf_get_formats ();
GSList *writable_formats = NULL;
g_slist_foreach (formats, add_if_writable, &amp;writable_formats);
g_slist_free (formats);
]|

If @error is set, %FALSE will be returned. Possible errors include 
those in the #GDK_PIXBUF_ERROR domain and those in the #G_FILE_ERROR domain.

The variable argument list should be %NULL-terminated; if not empty,
it should contain pairs of strings that modify the save
parameters. For example:
&lt;informalexample&gt;&lt;programlisting&gt;
gdk_pixbuf_save (pixbuf, handle, &quot;jpeg&quot;, &amp;error,
&quot;quality&quot;, &quot;100&quot;, NULL);
&lt;/programlisting&gt;&lt;/informalexample&gt;

Currently only few parameters exist. JPEG images can be saved with a
&quot;quality&quot; parameter; its value should be in the range [0,100].

Text chunks can be attached to PNG images by specifying parameters of
the form &quot;tEXt::key&quot;, where key is an ASCII string of length 1-79.
The values are UTF-8 encoded strings. The PNG compression level can
be specified using the &quot;compression&quot; parameter; it's value is in an
integer in the range of [0,9].

ICC color profiles can also be embedded into PNG, JPEG and TIFF images.
The &quot;icc-profile&quot; value should be the complete ICC profile encoded
into base64.

&lt;informalexample&gt;&lt;programlisting&gt;
gchar *contents;
gchar *contents_encode;
gsize length;
g_file_get_contents (&quot;/home/hughsie/.color/icc/L225W.icm&quot;, &amp;contents, &amp;length, NULL);
contents_encode = g_base64_encode ((const guchar *) contents, length);
gdk_pixbuf_save (pixbuf, handle, &quot;png&quot;, &amp;error,
&quot;icc-profile&quot;, contents_encode,
NULL);
&lt;/programlisting&gt;&lt;/informalexample&gt;

TIFF images recognize a &quot;compression&quot; option which acceps an integer value.
Among the codecs are 1 None, 2 Huffman, 5 LZW, 7 JPEG and 8 Deflate, see
the libtiff documentation and tiff.h for all supported codec values.

ICO images can be saved in depth 16, 24, or 32, by using the &quot;depth&quot;
parameter. When the ICO saver is given &quot;x_hot&quot; and &quot;y_hot&quot; parameters,
it produces a CUR instead of an ICO.


</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> a #GdkPixbuf.
</parameter_description>
</parameter>
<parameter name="filename">
<parameter_description> name of file to save.
</parameter_description>
</parameter>
<parameter name="type">
<parameter_description> name of file format.
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> return location for error, or %NULL
</parameter_description>
</parameter>
<parameter name="Varargs">
<parameter_description> list of key-value save options, followed by %NULL
</parameter_description>
</parameter>
</parameters>
<return> whether an error was set
</return>
</function>

<function name="gdk_pixbuf_save_to_buffer">
<description>
Saves pixbuf to a new buffer in format @type, which is currently &quot;jpeg&quot;,
&quot;png&quot;, &quot;tiff&quot;, &quot;ico&quot; or &quot;bmp&quot;.  This is a convenience function that uses
gdk_pixbuf_save_to_callback() to do the real work. Note that the buffer 
is not nul-terminated and may contain embedded  nuls.
If @error is set, %FALSE will be returned and @buffer will be set to
%NULL. Possible errors include those in the #GDK_PIXBUF_ERROR
domain.

See gdk_pixbuf_save() for more details.

Since: 2.4

</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> a #GdkPixbuf.
</parameter_description>
</parameter>
<parameter name="buffer">
<parameter_description> location to receive a pointer
to the new buffer.
</parameter_description>
</parameter>
<parameter name="buffer_size">
<parameter_description> location to receive the size of the new buffer.
</parameter_description>
</parameter>
<parameter name="type">
<parameter_description> name of file format.
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> return location for error, or %NULL
</parameter_description>
</parameter>
<parameter name="Varargs">
<parameter_description> list of key-value save options
</parameter_description>
</parameter>
</parameters>
<return> whether an error was set

</return>
</function>

<function name="gdk_pixbuf_save_to_bufferv">
<description>
Saves pixbuf to a new buffer in format @type, which is currently &quot;jpeg&quot;,
&quot;tiff&quot;, &quot;png&quot;, &quot;ico&quot; or &quot;bmp&quot;.  See gdk_pixbuf_save_to_buffer() 
for more details.

Since: 2.4

</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> a #GdkPixbuf.
</parameter_description>
</parameter>
<parameter name="buffer">
<parameter_description>
location to receive a pointer to the new buffer.
</parameter_description>
</parameter>
<parameter name="buffer_size">
<parameter_description> location to receive the size of the new buffer.
</parameter_description>
</parameter>
<parameter name="type">
<parameter_description> name of file format.
</parameter_description>
</parameter>
<parameter name="option_keys">
<parameter_description> name of options to set, %NULL-terminated
</parameter_description>
</parameter>
<parameter name="option_values">
<parameter_description> values for named options
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> return location for error, or %NULL
</parameter_description>
</parameter>
</parameters>
<return> whether an error was set

</return>
</function>

<function name="gdk_pixbuf_save_to_callback">
<description>
Saves pixbuf in format @type by feeding the produced data to a 
callback. Can be used when you want to store the image to something 
other than a file, such as an in-memory buffer or a socket.  
If @error is set, %FALSE will be returned. Possible errors
include those in the #GDK_PIXBUF_ERROR domain and whatever the save
function generates.

See gdk_pixbuf_save() for more details.

Since: 2.4

</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> a #GdkPixbuf.
</parameter_description>
</parameter>
<parameter name="save_func">
<parameter_description> a function that is called to save each block of data that
the save routine generates.
</parameter_description>
</parameter>
<parameter name="user_data">
<parameter_description> user data to pass to the save function.
</parameter_description>
</parameter>
<parameter name="type">
<parameter_description> name of file format.
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> return location for error, or %NULL
</parameter_description>
</parameter>
<parameter name="Varargs">
<parameter_description> list of key-value save options
</parameter_description>
</parameter>
</parameters>
<return> whether an error was set

</return>
</function>

<function name="gdk_pixbuf_save_to_callbackv">
<description>
Saves pixbuf to a callback in format @type, which is currently &quot;jpeg&quot;,
&quot;png&quot;, &quot;tiff&quot;, &quot;ico&quot; or &quot;bmp&quot;.  If @error is set, %FALSE will be returned. See
gdk_pixbuf_save_to_callback () for more details.

Since: 2.4

</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> a #GdkPixbuf.
</parameter_description>
</parameter>
<parameter name="save_func">
<parameter_description> a function that is called to save each block of data that
the save routine generates.
</parameter_description>
</parameter>
<parameter name="user_data">
<parameter_description> user data to pass to the save function.
</parameter_description>
</parameter>
<parameter name="type">
<parameter_description> name of file format.
</parameter_description>
</parameter>
<parameter name="option_keys">
<parameter_description> name of options to set, %NULL-terminated
</parameter_description>
</parameter>
<parameter name="option_values">
<parameter_description> values for named options
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> return location for error, or %NULL
</parameter_description>
</parameter>
</parameters>
<return> whether an error was set

</return>
</function>

<function name="gdk_pixbuf_save_to_stream">
<description>
Saves @pixbuf to an output stream.

Supported file formats are currently &quot;jpeg&quot;, &quot;tiff&quot;, &quot;png&quot;, &quot;ico&quot; or 
&quot;bmp&quot;. See gdk_pixbuf_save_to_buffer() for more details.

The @cancellable can be used to abort the operation from another 
thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED 
will be returned. Other possible errors are in the #GDK_PIXBUF_ERROR 
and %G_IO_ERROR domains. 

The stream is not closed.

Since: 2.14

</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
<parameter name="stream">
<parameter_description> a #GOutputStream to save the pixbuf to
</parameter_description>
</parameter>
<parameter name="type">
<parameter_description> name of file format
</parameter_description>
</parameter>
<parameter name="cancellable">
<parameter_description> optional #GCancellable object, %NULL to ignore
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> return location for error, or %NULL
</parameter_description>
</parameter>
<parameter name="Varargs">
<parameter_description> list of key-value save options
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the pixbuf was saved successfully, %FALSE if an
error was set.

</return>
</function>

<function name="gdk_pixbuf_save_to_stream_async">
<description>
Saves @pixbuf to an output stream asynchronously.

For more details see gdk_pixbuf_save_to_stream(), which is the synchronous
version of this function.

When the operation is finished, @callback will be called in the main thread.
You can then call gdk_pixbuf_save_to_stream_finish() to get the result of the operation.

Since: 2.24

</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
<parameter name="stream">
<parameter_description> a #GOutputStream to which to save the pixbuf
</parameter_description>
</parameter>
<parameter name="type">
<parameter_description> name of file format
</parameter_description>
</parameter>
<parameter name="cancellable">
<parameter_description> optional #GCancellable object, %NULL to ignore
</parameter_description>
</parameter>
<parameter name="callback">
<parameter_description> a #GAsyncReadyCallback to call when the the pixbuf is loaded
</parameter_description>
</parameter>
<parameter name="user_data">
<parameter_description> the data to pass to the callback function
</parameter_description>
</parameter>
<parameter name="Varargs">
<parameter_description> list of key-value save options
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_pixbuf_save_to_stream_finish">
<description>
Finishes an asynchronous pixbuf save operation started with
gdk_pixbuf_save_to_stream_async().

Since: 2.24

</description>
<parameters>
<parameter name="async_result">
<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the pixbuf was saved successfully, %FALSE if an error was set.

</return>
</function>

<function name="gdk_pixbuf_savev">
<description>
Saves pixbuf to a file in @type, which is currently &quot;jpeg&quot;, &quot;png&quot;, &quot;tiff&quot;, &quot;ico&quot; or &quot;bmp&quot;.
If @error is set, %FALSE will be returned. 
See gdk_pixbuf_save () for more details.


</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> a #GdkPixbuf.
</parameter_description>
</parameter>
<parameter name="filename">
<parameter_description> name of file to save.
</parameter_description>
</parameter>
<parameter name="type">
<parameter_description> name of file format.
</parameter_description>
</parameter>
<parameter name="option_keys">
<parameter_description> name of options to set, %NULL-terminated
</parameter_description>
</parameter>
<parameter name="option_values">
<parameter_description> values for named options
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> return location for error, or %NULL
</parameter_description>
</parameter>
</parameters>
<return> whether an error was set
</return>
</function>

<function name="gdk_pixbuf_scale">
<description>
Creates a transformation of the source image @src by scaling by
@scale_x and @scale_y then translating by @offset_x and @offset_y,
then renders the rectangle (@dest_x, @dest_y, @dest_width,
@dest_height) of the resulting image onto the destination image
replacing the previous contents.

Try to use gdk_pixbuf_scale_simple() first, this function is
the industrial-strength power tool you can fall back to if
gdk_pixbuf_scale_simple() isn't powerful enough.

If the source rectangle overlaps the destination rectangle on the
same pixbuf, it will be overwritten during the scaling which
results in rendering artifacts.

</description>
<parameters>
<parameter name="src">
<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
<parameter name="dest">
<parameter_description> the #GdkPixbuf into which to render the results
</parameter_description>
</parameter>
<parameter name="dest_x">
<parameter_description> the left coordinate for region to render
</parameter_description>
</parameter>
<parameter name="dest_y">
<parameter_description> the top coordinate for region to render
</parameter_description>
</parameter>
<parameter name="dest_width">
<parameter_description> the width of the region to render
</parameter_description>
</parameter>
<parameter name="dest_height">
<parameter_description> the height of the region to render
</parameter_description>
</parameter>
<parameter name="offset_x">
<parameter_description> the offset in the X direction (currently rounded to an integer)
</parameter_description>
</parameter>
<parameter name="offset_y">
<parameter_description> the offset in the Y direction (currently rounded to an integer)
</parameter_description>
</parameter>
<parameter name="scale_x">
<parameter_description> the scale factor in the X direction
</parameter_description>
</parameter>
<parameter name="scale_y">
<parameter_description> the scale factor in the Y direction
</parameter_description>
</parameter>
<parameter name="interp_type">
<parameter_description> the interpolation type for the transformation.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_pixbuf_scale_simple">
<description>
Create a new #GdkPixbuf containing a copy of @src scaled to
@dest_width x @dest_height. Leaves @src unaffected.  @interp_type
should be #GDK_INTERP_NEAREST if you want maximum speed (but when
scaling down #GDK_INTERP_NEAREST is usually unusably ugly).  The
default @interp_type should be #GDK_INTERP_BILINEAR which offers
reasonable quality and speed.

You can scale a sub-portion of @src by creating a sub-pixbuf
pointing into @src; see gdk_pixbuf_new_subpixbuf().

For more complicated scaling/compositing see gdk_pixbuf_scale()
and gdk_pixbuf_composite().


</description>
<parameters>
<parameter name="src">
<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
<parameter name="dest_width">
<parameter_description> the width of destination image
</parameter_description>
</parameter>
<parameter name="dest_height">
<parameter_description> the height of destination image
</parameter_description>
</parameter>
<parameter name="interp_type">
<parameter_description> the interpolation type for the transformation.
</parameter_description>
</parameter>
</parameters>
<return> the new #GdkPixbuf, or %NULL if not enough memory could be
allocated for it.
</return>
</function>

<function name="gdk_pixbuf_set_option">
<description>
Attaches a key/value pair as an option to a #GdkPixbuf. If @key already
exists in the list of options attached to @pixbuf, the new value is 
ignored and %FALSE is returned.

Since: 2.2

</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
<parameter name="key">
<parameter_description> a nul-terminated string.
</parameter_description>
</parameter>
<parameter name="value">
<parameter_description> a nul-terminated string.
</parameter_description>
</parameter>
</parameters>
<return> %TRUE on success.

</return>
</function>

<function name="gdk_pixbuf_simple_anim_add_frame">
<description>
Adds a new frame to @animation. The @pixbuf must
have the dimensions specified when the animation 
was constructed.

Since: 2.8

</description>
<parameters>
<parameter name="animation">
<parameter_description> a #GdkPixbufSimpleAnim
</parameter_description>
</parameter>
<parameter name="pixbuf">
<parameter_description> the pixbuf to add 
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_pixbuf_simple_anim_get_loop">
<description>
Gets whether @animation should loop indefinitely when it reaches the end.

Since: 2.18

</description>
<parameters>
<parameter name="animation">
<parameter_description> a #GdkPixbufSimpleAnim
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the animation loops forever, %FALSE otherwise

</return>
</function>

<function name="gdk_pixbuf_simple_anim_new">
<description>
Creates a new, empty animation.

Since: 2.8

</description>
<parameters>
<parameter name="width">
<parameter_description> the width of the animation
</parameter_description>
</parameter>
<parameter name="height">
<parameter_description> the height of the animation
</parameter_description>
</parameter>
<parameter name="rate">
<parameter_description> the speed of the animation, in frames per second
</parameter_description>
</parameter>
</parameters>
<return> a newly allocated #GdkPixbufSimpleAnim 

</return>
</function>

<function name="gdk_pixbuf_simple_anim_set_loop">
<description>
Sets whether @animation should loop indefinitely when it reaches the end.

Since: 2.18

</description>
<parameters>
<parameter name="animation">
<parameter_description> a #GdkPixbufSimpleAnim
</parameter_description>
</parameter>
<parameter name="loop">
<parameter_description> whether to loop the animation
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_pixbuf_unref">
<description>
Removes a reference from a pixbuf.

Deprecated: 2.0: Use g_object_unref().

</description>
<parameters>
<parameter name="pixbuf">
<parameter_description> A pixbuf.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_pixbuf_version">
<description>
Contains the full version of the &amp;gdk-pixbuf; library as a string.
This is the version currently in use by a running program.

</description>
<parameters>
</parameters>
<return></return>
</function>

<function name="gdk_pixdata_deserialize">
<description>
Deserializes (reconstruct) a #GdkPixdata structure from a byte stream.
The byte stream consists of a straightforward writeout of the
#GdkPixdata fields in network byte order, plus the @pixel_data
bytes the structure points to.
The @pixdata contents are reconstructed byte by byte and are checked
for validity. This function may fail with %GDK_PIXBUF_ERROR_CORRUPT_IMAGE
or %GDK_PIXBUF_ERROR_UNKNOWN_TYPE.


</description>
<parameters>
<parameter name="pixdata">
<parameter_description> a #GdkPixdata structure to be filled in.
</parameter_description>
</parameter>
<parameter name="stream_length">
<parameter_description> length of the stream used for deserialization.
</parameter_description>
</parameter>
<parameter name="stream">
<parameter_description> stream of bytes containing a
serialized #GdkPixdata structure.
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> #GError location to indicate failures (maybe %NULL to ignore errors).
</parameter_description>
</parameter>
</parameters>
<return> Upon successful deserialization %TRUE is returned,
%FALSE otherwise.
</return>
</function>

<function name="gdk_pixdata_from_pixbuf">
<description>
Converts a #GdkPixbuf to a #GdkPixdata. If @use_rle is %TRUE, the
pixel data is run-length encoded into newly-allocated memory and a 
pointer to that memory is returned. 


</description>
<parameters>
<parameter name="pixdata">
<parameter_description> a #GdkPixdata to fill.
</parameter_description>
</parameter>
<parameter name="pixbuf">
<parameter_description> the data to fill @pixdata with.
</parameter_description>
</parameter>
<parameter name="use_rle">
<parameter_description> whether to use run-length encoding for the pixel data.
</parameter_description>
</parameter>
</parameters>
<return> If @ure_rle is %TRUE, a pointer to the newly-allocated memory 
for the run-length encoded pixel data, otherwise %NULL.
</return>
</function>

<function name="gdk_pixdata_serialize">
<description>
Serializes a #GdkPixdata structure into a byte stream.
The byte stream consists of a straightforward writeout of the
#GdkPixdata fields in network byte order, plus the @pixel_data
bytes the structure points to.


</description>
<parameters>
<parameter name="pixdata">
<parameter_description> a valid #GdkPixdata structure to serialize.
</parameter_description>
</parameter>
<parameter name="stream_length_p">
<parameter_description> location to store the resulting stream length in.
</parameter_description>
</parameter>
</parameters>
<return> A
newly-allocated string containing the serialized #GdkPixdata
structure.
</return>
</function>

<function name="gdk_pixdata_to_csource">
<description>
Generates C source code suitable for compiling images directly 
into programs. 

gdk-pixbuf ships with a program called &lt;command&gt;gdk-pixbuf-csource&lt;/command&gt; 
which offers a command line interface to this function.


</description>
<parameters>
<parameter name="pixdata">
<parameter_description> a #GdkPixdata to convert to C source.
</parameter_description>
</parameter>
<parameter name="name">
<parameter_description> used for naming generated data structures or macros.
</parameter_description>
</parameter>
<parameter name="dump_type">
<parameter_description> a #GdkPixdataDumpType determining the kind of C
source to be generated.
</parameter_description>
</parameter>
</parameters>
<return> a newly-allocated string containing the C source form
of @pixdata.
</return>
</function>

<function name="gdk_pointer_grab">
<description>
Grabs the pointer (usually a mouse) so that all events are passed to this
application until the pointer is ungrabbed with gdk_pointer_ungrab(), or
the grab window becomes unviewable.
This overrides any previous pointer grab by this client.

Pointer grabs are used for operations which need complete control over mouse
events, even if the mouse leaves the application.
For example in GTK+ it is used for Drag and Drop, for dragging the handle in
the #GtkHPaned and #GtkVPaned widgets.

Note that if the event mask of an X window has selected both button press and
button release events, then a button press event will cause an automatic
pointer grab until the button is released.
X does this automatically since most applications expect to receive button
press and release events in pairs.
It is equivalent to a pointer grab on the window with @owner_events set to
%TRUE.

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 #GdkEventGrabBroken events that
are emitted when the grab ends unvoluntarily.

Deprecated: 3.0: Use gdk_device_grab() instead.

</description>
<parameters>
<parameter name="window">
<parameter_description> the #GdkWindow which will own the grab (the grab window).
</parameter_description>
</parameter>
<parameter name="owner_events">
<parameter_description> if %FALSE then all pointer events are reported with respect to
@window and are only reported if selected by @event_mask. If %TRUE then pointer
events for this application are reported as normal, but pointer events outside
this application are reported with respect to @window and only if selected by
@event_mask. In either mode, unreported events are discarded.
</parameter_description>
</parameter>
<parameter name="event_mask">
<parameter_description> specifies the event mask, which is used in accordance with
@owner_events. Note that only pointer events (i.e. button and motion events)
may be selected.
</parameter_description>
</parameter>
<parameter name="confine_to">
<parameter_description> If non-%NULL, the pointer will be confined to this
window during the grab. If the pointer is outside @confine_to, it will
automatically be moved to the closest edge of @confine_to and enter
and leave events will be generated as necessary.
</parameter_description>
</parameter>
<parameter name="cursor">
<parameter_description> the cursor to display while the grab is active. If this is %NULL then
the normal cursors are used for @window and its descendants, and the cursor
for @window is used for all other windows.
</parameter_description>
</parameter>
<parameter name="time_">
<parameter_description> the timestamp of the event which led to this pointer grab. This usually
comes from a #GdkEventButton struct, though %GDK_CURRENT_TIME can be used if
the time isn't known.
</parameter_description>
</parameter>
</parameters>
<return> %GDK_GRAB_SUCCESS if the grab was successful.

</return>
</function>

<function name="gdk_pointer_is_grabbed">
<description>
Returns %TRUE if the pointer on the default display is currently 
grabbed by this application.

Note that this does not take the inmplicit pointer grab on button
presses into account.

Deprecated: 3.0: Use gdk_display_device_is_grabbed() instead.

</description>
<parameters>
</parameters>
<return> %TRUE if the pointer is currently grabbed by this application.

</return>
</function>

<function name="gdk_pointer_ungrab">
<description>
Ungrabs the pointer on the default display, if it is grabbed by this 
application.

Deprecated: 3.0: Use gdk_device_ungrab(), together with gdk_device_grab()
instead.

</description>
<parameters>
<parameter name="time_">
<parameter_description> a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no 
timestamp is available.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_property_change">
<description>
Changes the contents of a property on a window.

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="property">
<parameter_description> the property to change
</parameter_description>
</parameter>
<parameter name="type">
<parameter_description> the new type for the property. If @mode is
%GDK_PROP_MODE_PREPEND or %GDK_PROP_MODE_APPEND, then this
must match the existing type or an error will occur.
</parameter_description>
</parameter>
<parameter name="format">
<parameter_description> the new format for the property. If @mode is
%GDK_PROP_MODE_PREPEND or %GDK_PROP_MODE_APPEND, then this
must match the existing format or an error will occur.
</parameter_description>
</parameter>
<parameter name="mode">
<parameter_description> a value describing how the new data is to be combined
with the current data.
</parameter_description>
</parameter>
<parameter name="data">
<parameter_description> the data (a &lt;literal&gt;guchar *&lt;/literal&gt;
&lt;literal&gt;gushort *&lt;/literal&gt;, or &lt;literal&gt;gulong *&lt;/literal&gt;,
depending on @format), cast to a &lt;literal&gt;guchar *&lt;/literal&gt;.
</parameter_description>
</parameter>
<parameter name="nelements">
<parameter_description> the number of elements of size determined by the format,
contained in @data.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_property_delete">
<description>
Deletes a property from a window.

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="property">
<parameter_description> the property to delete
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_property_get">
<description>
Retrieves a portion of the contents of a property. If the
property does not exist, then the function returns %FALSE,
and %GDK_NONE will be stored in @actual_property_type.

&lt;note&gt;
&lt;para&gt;
The XGetWindowProperty() function that gdk_property_get()
uses has a very confusing and complicated set of semantics.
Unfortunately, gdk_property_get() makes the situation
worse instead of better (the semantics should be considered
undefined), and also prints warnings to stderr in cases where it
should return a useful error to the program. You are advised to use
XGetWindowProperty() directly until a replacement function for
gdk_property_get()
is provided.
&lt;/para&gt;
&lt;/note&gt;


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="property">
<parameter_description> the property to retrieve
</parameter_description>
</parameter>
<parameter name="type">
<parameter_description> the desired property type, or %GDK_NONE, if any type of data
is acceptable. If this does not match the actual
type, then @actual_format and @actual_length will
be filled in, a warning will be printed to stderr
and no data will be returned.
</parameter_description>
</parameter>
<parameter name="offset">
<parameter_description> the offset into the property at which to begin
retrieving data, in 4 byte units.
</parameter_description>
</parameter>
<parameter name="length">
<parameter_description> the length of the data to retrieve in bytes.  Data is
considered to be retrieved in 4 byte chunks, so @length
will be rounded up to the next highest 4 byte boundary
(so be careful not to pass a value that might overflow
when rounded up).
</parameter_description>
</parameter>
<parameter name="pdelete">
<parameter_description> if %TRUE, delete the property after retrieving the
data.
</parameter_description>
</parameter>
<parameter name="actual_property_type">
<parameter_description> location to store the
actual type of the property.
</parameter_description>
</parameter>
<parameter name="actual_format">
<parameter_description> location to store the actual return format of the
data; either 8, 16 or 32 bits.
</parameter_description>
</parameter>
<parameter name="actual_length">
<parameter_description> location to store the length of the retrieved data, in
bytes.  Data returned in the 32 bit format is stored
in a long variable, so the actual number of 32 bit
elements should be be calculated via
@actual_length / sizeof(glong) to ensure portability to
64 bit systems.
</parameter_description>
</parameter>
<parameter name="data">
<parameter_description> location
to store a pointer to the data. The retrieved data should be
freed with g_free() when you are finished using it.
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if data was successfully received and stored
in @data, otherwise %FALSE.
</return>
</function>

<function name="gdk_query_depths">
<description>
This function returns the available bit depths for the default
screen. It's equivalent to listing the visuals
(gdk_list_visuals()) and then looking at the depth field in each
visual, removing duplicates.

The array returned by this function should not be freed.

</description>
<parameters>
<parameter name="depths">
<parameter_description> return
location for available depths
</parameter_description>
</parameter>
<parameter name="count">
<parameter_description> return location for number of available depths
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_query_visual_types">
<description>
This function returns the available visual types for the default
screen. It's equivalent to listing the visuals
(gdk_list_visuals()) and then looking at the type field in each
visual, removing duplicates.

The array returned by this function should not be freed.

</description>
<parameters>
<parameter name="visual_types">
<parameter_description> return
location for the available visual types
</parameter_description>
</parameter>
<parameter name="count">
<parameter_description> return location for the number of available visual types
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_rectangle_intersect">
<description>
Calculates the intersection of two rectangles. It is allowed for
@dest to be the same as either @src1 or @src2. If the rectangles 
do not intersect, @dest's width and height is set to 0 and its x 
and y values are undefined. If you are only interested in whether
the rectangles intersect, but not in the intersecting area itself,
pass %NULL for @dest.


</description>
<parameters>
<parameter name="src1">
<parameter_description> a #GdkRectangle
</parameter_description>
</parameter>
<parameter name="src2">
<parameter_description> a #GdkRectangle
</parameter_description>
</parameter>
<parameter name="dest">
<parameter_description> return location for the
intersection of @src1 and @src2, or %NULL
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the rectangles intersect.
</return>
</function>

<function name="gdk_rectangle_union">
<description>
Calculates the union of two rectangles.
The union of rectangles @src1 and @src2 is the smallest rectangle which
includes both @src1 and @src2 within it.
It is allowed for @dest to be the same as either @src1 or @src2.

</description>
<parameters>
<parameter name="src1">
<parameter_description> a #GdkRectangle
</parameter_description>
</parameter>
<parameter name="src2">
<parameter_description> a #GdkRectangle
</parameter_description>
</parameter>
<parameter name="dest">
<parameter_description> return location for the union of @src1 and @src2
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_rgba_copy">
<description>
Makes a copy of a #GdkRGBA structure.

The result must be freed through gdk_rgba_free().

Since: 3.0

</description>
<parameters>
<parameter name="rgba">
<parameter_description> a #GdkRGBA
</parameter_description>
</parameter>
</parameters>
<return> A newly allocated #GdkRGBA, with the same contents as @rgba

</return>
</function>

<function name="gdk_rgba_equal">
<description>
Compares two RGBA colors.

Since: 3.0

</description>
<parameters>
<parameter name="p1">
<parameter_description> a #GdkRGBA pointer
</parameter_description>
</parameter>
<parameter name="p2">
<parameter_description> another #GdkRGBA pointer
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the two colors compare equal

</return>
</function>

<function name="gdk_rgba_free">
<description>
Frees a #GdkRGBA struct created with gdk_rgba_copy()

Since: 3.0

</description>
<parameters>
<parameter name="rgba">
<parameter_description> a #GdkRGBA
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_rgba_hash">
<description>
A hash function suitable for using for a hash
table that stores #GdkRGBAs.

Since: 3.0

</description>
<parameters>
<parameter name="p">
<parameter_description> a #GdkRGBA pointer
</parameter_description>
</parameter>
</parameters>
<return> The hash value for @p

</return>
</function>

<function name="gdk_rgba_parse">
<description>
Parses a textual representation of a color, filling in
the &lt;structfield&gt;red&lt;/structfield&gt;, &lt;structfield&gt;green&lt;/structfield&gt;,
&lt;structfield&gt;blue&lt;/structfield&gt; and &lt;structfield&gt;alpha&lt;/structfield&gt;
fields of the @rgba struct.

The string can be either one of:
&lt;itemizedlist&gt;
&lt;listitem&gt;
A standard name (Taken from the X11 rgb.txt file).
&lt;/listitem&gt;
&lt;listitem&gt;
A hex value in the form '&#35;rgb' '&#35;rrggbb' '&#35;rrrgggbbb'
or '&#35;rrrrggggbbbb'
&lt;/listitem&gt;
&lt;listitem&gt;
A RGB color in the form 'rgb(r,g,b)' (In this case the color will
have full opacity)
&lt;/listitem&gt;
&lt;listitem&gt;
A RGBA color in the form 'rgba(r,g,b,a)'
&lt;/listitem&gt;
&lt;/itemizedlist&gt;

Where 'r', 'g', 'b' and 'a' are respectively the red, green, blue and
alpha color values. In the last two cases, r g and b are either integers
in the range 0 to 255 or precentage values in the range 0% to 100%, and
a is a floating point value in the range 0 to 1.

Since: 3.0

</description>
<parameters>
<parameter name="rgba">
<parameter_description> the #GdkRGBA struct to fill in
</parameter_description>
</parameter>
<parameter name="spec">
<parameter_description> the string specifying the color
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the parsing succeeded

</return>
</function>

<function name="gdk_rgba_to_string">
<description>
Returns a textual specification of @rgba in the form
&lt;literal&gt;rgb (r, g, b)&lt;/literal&gt; or
&lt;literal&gt;rgba (r, g, b, a)&lt;/literal&gt;,
where 'r', 'g', 'b' and 'a' represent the red, green,
blue and alpha values respectively. r, g, and b are
represented as integers in the range 0 to 255, and a
is represented as floating point value in the range 0 to 1.

These string forms are string forms those supported by
the CSS3 colors module, and can be parsed by gdk_rgba_parse().

Note that this string representation may loose some
precision, since r, g and b are represented as 8-bit
integers. If this is a concern, you should use a
different representation.

Since: 3.0

</description>
<parameters>
<parameter name="rgba">
<parameter_description> a #GdkRGBA
</parameter_description>
</parameter>
</parameters>
<return> A newly allocated text string

</return>
</function>

<function name="gdk_screen_get_active_window">
<description>
Returns the screen's currently active window.

On X11, this is done by inspecting the _NET_ACTIVE_WINDOW property
on the root window, as described in the &lt;ulink
url=&quot;http://www.freedesktop.org/Standards/wm-spec&quot;&gt;Extended Window
Manager Hints&lt;/ulink&gt;. If there is no currently currently active
window, or the window manager does not support the
_NET_ACTIVE_WINDOW hint, this function returns %NULL.

On other platforms, this function may return %NULL, depending on whether
it is implementable on that platform.

The returned window should be unrefed using g_object_unref() when
no longer needed.

Since: 2.10

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return> the currently active window, or %NULL.

</return>
</function>

<function name="gdk_screen_get_default">
<description>
Gets the default screen for the default display. (See
gdk_display_get_default ()).

Since: 2.2

</description>
<parameters>
</parameters>
<return> a #GdkScreen, or %NULL if there is no default display.

</return>
</function>

<function name="gdk_screen_get_display">
<description>
Gets the display to which the @screen belongs.

Since: 2.2

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return> the display to which @screen belongs

</return>
</function>

<function name="gdk_screen_get_font_options">
<description>
Gets any options previously set with gdk_screen_set_font_options().

Since: 2.10

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return> the current font options, or %NULL if no default
font options have been set.

</return>
</function>

<function name="gdk_screen_get_height">
<description>
Gets the height of @screen in pixels

Since: 2.2

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return> the height of @screen in pixels.

</return>
</function>

<function name="gdk_screen_get_height_mm">
<description>
Returns the height of @screen in millimeters.
Note that on some X servers this value will not be correct.

Since: 2.2

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return> the heigth of @screen in millimeters.

</return>
</function>

<function name="gdk_screen_get_monitor_at_point">
<description>
Returns the monitor number in which the point (@x,@y) is located.

Since: 2.2

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen.
</parameter_description>
</parameter>
<parameter name="x">
<parameter_description> the x coordinate in the virtual screen.
</parameter_description>
</parameter>
<parameter name="y">
<parameter_description> the y coordinate in the virtual screen.
</parameter_description>
</parameter>
</parameters>
<return> the monitor number in which the point (@x,@y) lies, or
a monitor close to (@x,@y) if the point is not in any monitor.

</return>
</function>

<function name="gdk_screen_get_monitor_at_window">
<description>
Returns the number of the monitor in which the largest area of the
bounding rectangle of @window resides.

Since: 2.2

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen.
</parameter_description>
</parameter>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> the monitor number in which most of @window is located,
or if @window does not intersect any monitors, a monitor,
close to @window.

</return>
</function>

<function name="gdk_screen_get_monitor_geometry">
<description>
Retrieves the #GdkRectangle representing the size and position of
the individual monitor within the entire screen area.

Monitor numbers start at 0. To obtain the number of monitors of
@screen, use gdk_screen_get_n_monitors().

Note that the size of the entire screen area can be retrieved via
gdk_screen_get_width() and gdk_screen_get_height().

Since: 2.2

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
<parameter name="monitor_num">
<parameter_description> the monitor number
</parameter_description>
</parameter>
<parameter name="dest">
<parameter_description> a #GdkRectangle to be filled with
the monitor geometry
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_screen_get_monitor_height_mm">
<description>
Gets the height in millimeters of the specified monitor.

Since: 2.14

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
<parameter name="monitor_num">
<parameter_description> number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
</parameter_description>
</parameter>
</parameters>
<return> the height of the monitor, or -1 if not available

</return>
</function>

<function name="gdk_screen_get_monitor_plug_name">
<description>
Returns the output name of the specified monitor.
Usually something like VGA, DVI, or TV, not the actual
product name of the display device.

Since: 2.14

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
<parameter name="monitor_num">
<parameter_description> number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
</parameter_description>
</parameter>
</parameters>
<return> a newly-allocated string containing the name of the monitor,
or %NULL if the name cannot be determined

</return>
</function>

<function name="gdk_screen_get_monitor_width_mm">
<description>
Gets the width in millimeters of the specified monitor, if available.

Since: 2.14

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
<parameter name="monitor_num">
<parameter_description> number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
</parameter_description>
</parameter>
</parameters>
<return> the width of the monitor, or -1 if not available

</return>
</function>

<function name="gdk_screen_get_monitor_workarea">
<description>
Retrieves the #GdkRectangle representing the size and position of
the &quot;work area&quot; on a monitor within the entire screen area.

The work area should be considered when positioning menus and
similar popups, to avoid placing them below panels, docks or other
desktop components.

Monitor numbers start at 0. To obtain the number of monitors of
@screen, use gdk_screen_get_n_monitors().

Since: 3.4

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
<parameter name="monitor_num">
<parameter_description> the monitor number
</parameter_description>
</parameter>
<parameter name="dest">
<parameter_description> a #GdkRectangle to be filled with
the monitor workarea
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_screen_get_n_monitors">
<description>
Returns the number of monitors which @screen consists of.

Since: 2.2

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return> number of monitors which @screen consists of

</return>
</function>

<function name="gdk_screen_get_number">
<description>
Gets the index of @screen among the screens in the display
to which it belongs. (See gdk_screen_get_display())

Since: 2.2

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return> the index

</return>
</function>

<function name="gdk_screen_get_primary_monitor">
<description>
Gets the primary monitor for @screen.  The primary monitor
is considered the monitor where the 'main desktop' lives.
While normal application windows typically allow the window
manager to place the windows, specialized desktop applications
such as panels should place themselves on the primary monitor.

If no primary monitor is configured by the user, the return value
will be 0, defaulting to the first monitor.

Since: 2.20

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen.
</parameter_description>
</parameter>
</parameters>
<return> An integer index for the primary monitor, or 0 if none is configured.

</return>
</function>

<function name="gdk_screen_get_resolution">
<description>
Gets the resolution for font handling on the screen; see
gdk_screen_set_resolution() for full details.

Since: 2.10

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return> the current resolution, or -1 if no resolution
has been set.

</return>
</function>

<function name="gdk_screen_get_rgba_visual">
<description>
Gets a visual to use for creating windows with an alpha channel.
The windowing system on which GTK+ is running
may not support this capability, in which case %NULL will
be returned. Even if a non-%NULL value is returned, its
possible that the window's alpha channel won't be honored
when displaying the window on the screen: in particular, for
X an appropriate windowing manager and compositing manager
must be running to provide appropriate display.

This functionality is not implemented in the Windows backend.

For setting an overall opacity for a top-level window, see
gdk_window_set_opacity().

Since: 2.8

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return> a visual to use for windows with an
alpha channel or %NULL if the capability is not available.

</return>
</function>

<function name="gdk_screen_get_root_window">
<description>
Gets the root window of @screen.

Since: 2.2

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return> the root window

</return>
</function>

<function name="gdk_screen_get_setting">
<description>
Retrieves a desktop-wide setting such as double-click time
for the #GdkScreen @screen.

FIXME needs a list of valid settings here, or a link to
more information.

Since: 2.2

</description>
<parameters>
<parameter name="screen">
<parameter_description> the #GdkScreen where the setting is located
</parameter_description>
</parameter>
<parameter name="name">
<parameter_description> the name of the setting
</parameter_description>
</parameter>
<parameter name="value">
<parameter_description> location to store the value of the setting
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the setting existed and a value was stored
in @value, %FALSE otherwise.

</return>
</function>

<function name="gdk_screen_get_system_visual">
<description>
Get the system's default visual for @screen.
This is the visual for the root window of the display.
The return value should not be freed.

Since: 2.2

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen.
</parameter_description>
</parameter>
</parameters>
<return> the system visual

</return>
</function>

<function name="gdk_screen_get_toplevel_windows">
<description>
Obtains a list of all toplevel windows known to GDK on the screen @screen.
A toplevel window is a child of the root window (see
gdk_get_default_root_window()).

The returned list should be freed with g_list_free(), but
its elements need not be freed.

Since: 2.2

</description>
<parameters>
<parameter name="screen">
<parameter_description> The #GdkScreen where the toplevels are located.
</parameter_description>
</parameter>
</parameters>
<return>
list of toplevel windows, free with g_list_free()

</return>
</function>

<function name="gdk_screen_get_width">
<description>
Gets the width of @screen in pixels

Since: 2.2

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return> the width of @screen in pixels.

</return>
</function>

<function name="gdk_screen_get_width_mm">
<description>
Gets the width of @screen in millimeters.
Note that on some X servers this value will not be correct.

Since: 2.2

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return> the width of @screen in millimeters.

</return>
</function>

<function name="gdk_screen_get_window_stack">
<description>
Returns a #GList of #GdkWindow&lt;!-- --&gt;s representing the current
window stack.

On X11, this is done by inspecting the _NET_CLIENT_LIST_STACKING
property on the root window, as described in the &lt;ulink
url=&quot;http://www.freedesktop.org/Standards/wm-spec&quot;&gt;Extended Window
Manager Hints&lt;/ulink&gt;. If the window manager does not support the
_NET_CLIENT_LIST_STACKING hint, this function returns %NULL.

On other platforms, this function may return %NULL, depending on whether
it is implementable on that platform.

The returned list is newly allocated and owns references to the
windows it contains, so it should be freed using g_list_free() and
its windows unrefed using g_object_unref() when no longer needed.

Since: 2.10

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return>
a list of #GdkWindow&lt;!-- --&gt;s for the current window stack,
or %NULL.

</return>
</function>

<function name="gdk_screen_height">
<description>
Returns the height of the default screen in pixels.


</description>
<parameters>
</parameters>
<return> the height of the default screen in pixels.
</return>
</function>

<function name="gdk_screen_height_mm">
<description>
Returns the height of the default screen in millimeters.
Note that on many X servers this value will not be correct.


</description>
<parameters>
</parameters>
<return> the height of the default screen in millimeters,
though it is not always correct.
</return>
</function>

<function name="gdk_screen_is_composited">
<description>
Returns whether windows with an RGBA visual can reasonably
be expected to have their alpha channel drawn correctly on
the screen.

On X11 this function returns whether a compositing manager is
compositing @screen.

Since: 2.10

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return> Whether windows with RGBA visuals can reasonably be
expected to have their alpha channels drawn correctly on the screen.

</return>
</function>

<function name="gdk_screen_list_visuals">
<description>
Lists the available visuals for the specified @screen.
A visual describes a hardware image data format.
For example, a visual might support 24-bit color, or 8-bit color,
and might expect pixels to be in a certain format.

Call g_list_free() on the return value when you're finished with it.

Since: 2.2

</description>
<parameters>
<parameter name="screen">
<parameter_description> the relevant #GdkScreen.
</parameter_description>
</parameter>
</parameters>
<return>
a list of visuals; the list must be freed, but not its contents

</return>
</function>

<function name="gdk_screen_make_display_name">
<description>
Determines the name to pass to gdk_display_open() to get
a #GdkDisplay with this screen as the default screen.

Since: 2.2

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return> a newly allocated string, free with g_free()

</return>
</function>

<function name="gdk_screen_set_font_options">
<description>
Sets the default font options for the screen. These
options will be set on any #PangoContext's newly created
with gdk_pango_context_get_for_screen(). Changing the
default set of font options does not affect contexts that
have already been created.

Since: 2.10

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
<parameter name="options">
<parameter_description> a #cairo_font_options_t, or %NULL to unset any
previously set default font options.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_screen_set_resolution">
<description>
Sets the resolution for font handling on the screen. This is a
scale factor between points specified in a #PangoFontDescription
and cairo units. The default value is 96, meaning that a 10 point
font will be 13 units high. (10 * 96. / 72. = 13.3).

Since: 2.10

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
<parameter name="dpi">
<parameter_description> the resolution in &quot;dots per inch&quot;. (Physical inches aren't actually
involved; the terminology is conventional.)
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_screen_width">
<description>
Returns the width of the default screen in pixels.


</description>
<parameters>
</parameters>
<return> the width of the default screen in pixels.
</return>
</function>

<function name="gdk_screen_width_mm">
<description>
Returns the width of the default screen in millimeters.
Note that on many X servers this value will not be correct.


</description>
<parameters>
</parameters>
<return> the width of the default screen in millimeters,
though it is not always correct.
</return>
</function>

<function name="gdk_selection_convert">
<description>
Retrieves the contents of a selection in a given
form.

</description>
<parameters>
<parameter name="requestor">
<parameter_description> a #GdkWindow.
</parameter_description>
</parameter>
<parameter name="selection">
<parameter_description> an atom identifying the selection to get the
contents of.
</parameter_description>
</parameter>
<parameter name="target">
<parameter_description> the form in which to retrieve the selection.
</parameter_description>
</parameter>
<parameter name="time_">
<parameter_description> the timestamp to use when retrieving the
selection. The selection owner may refuse the
request if it did not own the selection at
the time indicated by the timestamp.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_selection_owner_get">
<description>
Determines the owner of the given selection.


</description>
<parameters>
<parameter name="selection">
<parameter_description> an atom indentifying a selection.
</parameter_description>
</parameter>
</parameters>
<return> if there is a selection owner for
this window, and it is a window known to the current
process, the #GdkWindow that owns the selection, otherwise
%NULL. Note that the return value may be owned
by a different process if a foreign window
was previously created for that window, but
a new foreign window will never be created by
this call.
</return>
</function>

<function name="gdk_selection_owner_get_for_display">
<description>
Determine the owner of the given selection.

Note that the return value may be owned by a different
process if a foreign window was previously created for that
window, but a new foreign window will never be created by this call.

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
<parameter name="selection">
<parameter_description> an atom indentifying a selection
</parameter_description>
</parameter>
</parameters>
<return> if there is a selection owner for this window,
and it is a window known to the current process, the #GdkWindow that
owns the selection, otherwise %NULL.

</return>
</function>

<function name="gdk_selection_owner_set">
<description>
Sets the owner of the given selection.


</description>
<parameters>
<parameter name="owner">
<parameter_description> a #GdkWindow or %NULL to indicate that the
the owner for the given should be unset.
</parameter_description>
</parameter>
<parameter name="selection">
<parameter_description> an atom identifying a selection.
</parameter_description>
</parameter>
<parameter name="time_">
<parameter_description> timestamp to use when setting the selection.
If this is older than the timestamp given last
time the owner was set for the given selection, the
request will be ignored.
</parameter_description>
</parameter>
<parameter name="send_event">
<parameter_description> if %TRUE, and the new owner is different
from the current owner, the current owner
will be sent a SelectionClear event.
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the selection owner was successfully
changed to @owner, otherwise %FALSE.
</return>
</function>

<function name="gdk_selection_owner_set_for_display">
<description>
Sets the #GdkWindow @owner as the current owner of the selection @selection.

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description> the #GdkDisplay
</parameter_description>
</parameter>
<parameter name="owner">
<parameter_description> a #GdkWindow or %NULL to indicate that the owner for
the given should be unset
</parameter_description>
</parameter>
<parameter name="selection">
<parameter_description> an atom identifying a selection
</parameter_description>
</parameter>
<parameter name="time_">
<parameter_description> timestamp to use when setting the selection
If this is older than the timestamp given last time the owner was
set for the given selection, the request will be ignored
</parameter_description>
</parameter>
<parameter name="send_event">
<parameter_description> if %TRUE, and the new owner is different from the current
owner, the current owner will be sent a SelectionClear event
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the selection owner was successfully changed to owner,
otherwise %FALSE.

</return>
</function>

<function name="gdk_selection_property_get">
<description>
Retrieves selection data that was stored by the selection
data in response to a call to gdk_selection_convert(). This function
will not be used by applications, who should use the #GtkClipboard
API instead.


</description>
<parameters>
<parameter name="requestor">
<parameter_description> the window on which the data is stored
</parameter_description>
</parameter>
<parameter name="data">
<parameter_description> location to store a pointer to the retrieved data.
       If the retrieval failed, %NULL we be stored here, otherwise, it
       will be non-%NULL and the returned data should be freed with g_free()
       when you are finished using it. The length of the
       allocated memory is one more than the length
       of the returned data, and the final byte will always
       be zero, to ensure nul-termination of strings
</parameter_description>
</parameter>
<parameter name="prop_type">
<parameter_description> location to store the type of the property
</parameter_description>
</parameter>
<parameter name="prop_format">
<parameter_description> location to store the format of the property
</parameter_description>
</parameter>
</parameters>
<return> the length of the retrieved data.
</return>
</function>

<function name="gdk_selection_send_notify">
<description>
Sends a response to SelectionRequest event.

</description>
<parameters>
<parameter name="requestor">
<parameter_description> window to which to deliver response.
</parameter_description>
</parameter>
<parameter name="selection">
<parameter_description> selection that was requested.
</parameter_description>
</parameter>
<parameter name="target">
<parameter_description> target that was selected.
</parameter_description>
</parameter>
<parameter name="property">
<parameter_description> property in which the selection owner stored the
data, or %GDK_NONE to indicate that the request
was rejected.
</parameter_description>
</parameter>
<parameter name="time_">
<parameter_description> timestamp.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_selection_send_notify_for_display">
<description>
Send a response to SelectionRequest event.

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description> the #GdkDisplay where @requestor is realized
</parameter_description>
</parameter>
<parameter name="requestor">
<parameter_description> window to which to deliver response
</parameter_description>
</parameter>
<parameter name="selection">
<parameter_description> selection that was requested
</parameter_description>
</parameter>
<parameter name="target">
<parameter_description> target that was selected
</parameter_description>
</parameter>
<parameter name="property">
<parameter_description> property in which the selection owner stored the data,
or %GDK_NONE to indicate that the request was rejected
</parameter_description>
</parameter>
<parameter name="time_">
<parameter_description> timestamp
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_set_double_click_time">
<description>
Set the double click time for the default display. See
gdk_display_set_double_click_time(). 
See also gdk_display_set_double_click_distance().
Applications should &lt;emphasis&gt;not&lt;/emphasis&gt; set this, it is a 
global user-configured setting.

</description>
<parameters>
<parameter name="msec">
<parameter_description> double click time in milliseconds (thousandths of a second)
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_set_program_class">
<description>
Sets the program class. The X11 backend uses the program class to set
the class name part of the &lt;literal&gt;WM_CLASS&lt;/literal&gt; property on
toplevel windows; see the ICCCM.

</description>
<parameters>
<parameter name="program_class">
<parameter_description> a string.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_set_show_events">
<description>
Sets whether a trace of received events is output.
Note that GTK+ must be compiled with debugging (that is,
configured using the &lt;option&gt;--enable-debug&lt;/option&gt; option)
to use this option.

</description>
<parameters>
<parameter name="show_events">
<parameter_description>  %TRUE to output event debugging information.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_setting_get">
<description>
Obtains a desktop-wide setting, such as the double-click time,
for the default screen. See gdk_screen_get_setting().


</description>
<parameters>
<parameter name="name">
<parameter_description> the name of the setting.
</parameter_description>
</parameter>
<parameter name="value">
<parameter_description> location to store the value of the setting.
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the setting existed and a value was stored
in @value, %FALSE otherwise.
</return>
</function>

<function name="gdk_test_render_sync">
<description>
Retrieves a pixel from @window to force the windowing
system to carry out any pending rendering commands.

This function is intended to be used to synchronize with rendering
pipelines, to benchmark windowing system rendering operations.

Since: 2.14

</description>
<parameters>
<parameter name="window">
<parameter_description> a mapped #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_test_simulate_button">
<description>
This function is intended to be used in GTK+ test programs.
It will warp the mouse pointer to the given (@x,@y) coordinates
within @window and simulate a button press or release event.
Because the mouse pointer needs to be warped to the target
location, use of this function outside of test programs that
run in their own virtual windowing system (e.g. Xvfb) is not
recommended.

Also, gdk_test_simulate_button() is a fairly low level function,
for most testing purposes, gtk_test_widget_click() is the right
function to call which will generate a button press event followed
by its accompanying button release event.

Since: 2.14

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow to simulate a button event for
</parameter_description>
</parameter>
<parameter name="x">
<parameter_description>      x coordinate within @window for the button event
</parameter_description>
</parameter>
<parameter name="y">
<parameter_description>      y coordinate within @window for the button event
</parameter_description>
</parameter>
<parameter name="button">
<parameter_description> Number of the pointer button for the event, usually 1, 2 or 3
</parameter_description>
</parameter>
<parameter name="modifiers">
<parameter_description> Keyboard modifiers the event is setup with
</parameter_description>
</parameter>
<parameter name="button_pressrelease">
<parameter_description> either %GDK_BUTTON_PRESS or %GDK_BUTTON_RELEASE
</parameter_description>
</parameter>
</parameters>
<return> whether all actions necessary for a button event simulation
were carried out successfully

</return>
</function>

<function name="gdk_test_simulate_key">
<description>
This function is intended to be used in GTK+ test programs.
If (@x,@y) are &gt; (-1,-1), it will warp the mouse pointer to
the given (@x,@y) coordinates within @window and simulate a
key press or release event.

When the mouse pointer is warped to the target location, use
of this function outside of test programs that run in their
own virtual windowing system (e.g. Xvfb) is not recommended.
If (@x,@y) are passed as (-1,-1), the mouse pointer will not
be warped and @window origin will be used as mouse pointer
location for the event.

Also, gdk_test_simulate_key() is a fairly low level function,
for most testing purposes, gtk_test_widget_send_key() is the
right function to call which will generate a key press event
followed by its accompanying key release event.

Since: 2.14

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow to simulate a key event for
</parameter_description>
</parameter>
<parameter name="x">
<parameter_description>      x coordinate within @window for the key event
</parameter_description>
</parameter>
<parameter name="y">
<parameter_description>      y coordinate within @window for the key event
</parameter_description>
</parameter>
<parameter name="keyval">
<parameter_description> A GDK keyboard value
</parameter_description>
</parameter>
<parameter name="modifiers">
<parameter_description> Keyboard modifiers the event is setup with
</parameter_description>
</parameter>
<parameter name="key_pressrelease">
<parameter_description> either %GDK_KEY_PRESS or %GDK_KEY_RELEASE
</parameter_description>
</parameter>
</parameters>
<return> whether all actions necessary for a key event simulation
were carried out successfully

</return>
</function>

<function name="gdk_text_property_to_utf8_list_for_display">
<description>
Converts a text property in the given encoding to
a list of UTF-8 strings.

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description>  a #GdkDisplay
</parameter_description>
</parameter>
<parameter name="encoding">
<parameter_description> an atom representing the encoding of the text
</parameter_description>
</parameter>
<parameter name="format">
<parameter_description>   the format of the property
</parameter_description>
</parameter>
<parameter name="text">
<parameter_description> the text to convert
</parameter_description>
</parameter>
<parameter name="length">
<parameter_description>   the length of @text, in bytes
</parameter_description>
</parameter>
<parameter name="list">
<parameter_description> location to store the list
of strings or %NULL. The list should be freed with
g_strfreev().
</parameter_description>
</parameter>
</parameters>
<return> the number of strings in the resulting list

</return>
</function>

<function name="gdk_threads_add_idle">
<description>
A wrapper for the common usage of gdk_threads_add_idle_full() 
assigning the default priority, #G_PRIORITY_DEFAULT_IDLE.

See gdk_threads_add_idle_full().

Since: 2.12

</description>
<parameters>
<parameter name="function">
<parameter_description> function to call
</parameter_description>
</parameter>
<parameter name="data">
<parameter_description>     data to pass to @function
</parameter_description>
</parameter>
</parameters>
<return> the ID (greater than 0) of the event source.

</return>
</function>

<function name="gdk_threads_add_idle_full">
<description>
Adds a function to be called whenever there are no higher priority
events pending.  If the function returns %FALSE it is automatically
removed from the list of event sources and will not be called again.

This variant of g_idle_add_full() calls @function with the GDK lock
held. It can be thought of a MT-safe version for GTK+ widgets for the
following use case, where you have to worry about idle_callback()
running in thread A and accessing @self after it has been finalized
in thread B:

|[
static gboolean
idle_callback (gpointer data)
{
/ * gdk_threads_enter(); would be needed for g_idle_add() * /

SomeWidget *self = data;
/ * do stuff with self * /

self-&gt;idle_id = 0;

/ * gdk_threads_leave(); would be needed for g_idle_add() * /
return FALSE;
}

static void
some_widget_do_stuff_later (SomeWidget *self)
{
self-&gt;idle_id = gdk_threads_add_idle (idle_callback, self)
/ * using g_idle_add() here would require thread protection in the callback * /
}

static void
some_widget_finalize (GObject *object)
{
SomeWidget *self = SOME_WIDGET (object);
if (self-&gt;idle_id)
g_source_remove (self-&gt;idle_id);
G_OBJECT_CLASS (parent_class)-&gt;finalize (object);
}
]|

Since: 2.12

</description>
<parameters>
<parameter name="priority">
<parameter_description> the priority of the idle source. Typically this will be in the
range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE
</parameter_description>
</parameter>
<parameter name="function">
<parameter_description> function to call
</parameter_description>
</parameter>
<parameter name="data">
<parameter_description>     data to pass to @function
</parameter_description>
</parameter>
<parameter name="notify">
<parameter_description>   function to call when the idle is removed, or %NULL
</parameter_description>
</parameter>
</parameters>
<return> the ID (greater than 0) of the event source.

</return>
</function>

<function name="gdk_threads_add_timeout">
<description>
A wrapper for the common usage of gdk_threads_add_timeout_full() 
assigning the default priority, #G_PRIORITY_DEFAULT.

See gdk_threads_add_timeout_full().

Since: 2.12

</description>
<parameters>
<parameter name="interval">
<parameter_description> the time between calls to the function, in milliseconds
(1/1000ths of a second)
</parameter_description>
</parameter>
<parameter name="function">
<parameter_description> function to call
</parameter_description>
</parameter>
<parameter name="data">
<parameter_description>     data to pass to @function
</parameter_description>
</parameter>
</parameters>
<return> the ID (greater than 0) of the event source.

</return>
</function>

<function name="gdk_threads_add_timeout_full">
<description>
Sets a function to be called at regular intervals holding the GDK lock,
with the given priority.  The function is called repeatedly until it 
returns %FALSE, at which point the timeout is automatically destroyed 
and the function will not be called again.  The @notify function is
called when the timeout is destroyed.  The first call to the
function will be at the end of the first @interval.

Note that timeout functions may be delayed, due to the processing of other
event sources. Thus they should not be relied on for precise timing.
After each call to the timeout function, the time of the next
timeout is recalculated based on the current time and the given interval
(it does not try to 'catch up' time lost in delays).

This variant of g_timeout_add_full() can be thought of a MT-safe version 
for GTK+ widgets for the following use case:

|[
static gboolean timeout_callback (gpointer data)
{
SomeWidget *self = data;

/ * do stuff with self * /

self-&gt;timeout_id = 0;

return G_SOURCE_REMOVE;
}

static void some_widget_do_stuff_later (SomeWidget *self)
{
self-&gt;timeout_id = g_timeout_add (timeout_callback, self)
}

static void some_widget_finalize (GObject *object)
{
SomeWidget *self = SOME_WIDGET (object);

if (self-&gt;timeout_id)
g_source_remove (self-&gt;timeout_id);

G_OBJECT_CLASS (parent_class)-&gt;finalize (object);
}
]|

Since: 2.12

</description>
<parameters>
<parameter name="priority">
<parameter_description> the priority of the timeout source. Typically this will be in the
range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
</parameter_description>
</parameter>
<parameter name="interval">
<parameter_description> the time between calls to the function, in milliseconds
(1/1000ths of a second)
</parameter_description>
</parameter>
<parameter name="function">
<parameter_description> function to call
</parameter_description>
</parameter>
<parameter name="data">
<parameter_description>     data to pass to @function
</parameter_description>
</parameter>
<parameter name="notify">
<parameter_description>   function to call when the timeout is removed, or %NULL
</parameter_description>
</parameter>
</parameters>
<return> the ID (greater than 0) of the event source.

</return>
</function>

<function name="gdk_threads_add_timeout_seconds">
<description>
A wrapper for the common usage of gdk_threads_add_timeout_seconds_full() 
assigning the default priority, #G_PRIORITY_DEFAULT.

For details, see gdk_threads_add_timeout_full().

Since: 2.14

</description>
<parameters>
<parameter name="interval">
<parameter_description> the time between calls to the function, in seconds
</parameter_description>
</parameter>
<parameter name="function">
<parameter_description> function to call
</parameter_description>
</parameter>
<parameter name="data">
<parameter_description>     data to pass to @function
</parameter_description>
</parameter>
</parameters>
<return> the ID (greater than 0) of the event source.

</return>
</function>

<function name="gdk_threads_add_timeout_seconds_full">
<description>
A variant of gdk_threads_add_timeout_full() with second-granularity.
See g_timeout_add_seconds_full() for a discussion of why it is
a good idea to use this function if you don't need finer granularity.

Since: 2.14

</description>
<parameters>
<parameter name="priority">
<parameter_description> the priority of the timeout source. Typically this will be in the
range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
</parameter_description>
</parameter>
<parameter name="interval">
<parameter_description> the time between calls to the function, in seconds
</parameter_description>
</parameter>
<parameter name="function">
<parameter_description> function to call
</parameter_description>
</parameter>
<parameter name="data">
<parameter_description>     data to pass to @function
</parameter_description>
</parameter>
<parameter name="notify">
<parameter_description> function to call when the timeout is removed, or %NULL
</parameter_description>
</parameter>
</parameters>
<return> the ID (greater than 0) of the event source.

</return>
</function>

<function name="gdk_threads_enter">
<description>
This function marks the beginning of a critical section in which
GDK and GTK+ functions can be called safely and without causing race
conditions. Only one thread at a time can be in such a critial
section.

Deprecated:3.6: All GDK and GTK+ calls should be made from the main
thread

</description>
<parameters>
</parameters>
<return></return>
</function>

<function name="gdk_threads_init">
<description>
Initializes GDK so that it can be used from multiple threads
in conjunction with gdk_threads_enter() and gdk_threads_leave().

This call must be made before any use of the main loop from
GTK+; to be safe, call it before gtk_init().

Deprecated:3.6: All GDK and GTK+ calls should be made from the main
thread

</description>
<parameters>
</parameters>
<return></return>
</function>

<function name="gdk_threads_leave">
<description>
Leaves a critical region begun with gdk_threads_enter().

Deprecated:3.6: All GDK and GTK+ calls should be made from the main
thread

</description>
<parameters>
</parameters>
<return></return>
</function>

<function name="gdk_threads_set_lock_functions">
<description>
Allows the application to replace the standard method that
GDK uses to protect its data structures. Normally, GDK
creates a single #GMutex that is locked by gdk_threads_enter(),
and released by gdk_threads_leave(); using this function an
application provides, instead, a function @enter_fn that is
called by gdk_threads_enter() and a function @leave_fn that is
called by gdk_threads_leave().

The functions must provide at least same locking functionality
as the default implementation, but can also do extra application
specific processing.

As an example, consider an application that has its own recursive
lock that when held, holds the GTK+ lock as well. When GTK+ unlocks
the GTK+ lock when entering a recursive main loop, the application
must temporarily release its lock as well.

Most threaded GTK+ apps won't need to use this method.

This method must be called before gdk_threads_init(), and cannot
be called multiple times.

Deprecated:3.6: All GDK and GTK+ calls should be made from the main
thread

Since: 2.4

</description>
<parameters>
<parameter name="enter_fn">
<parameter_description>   function called to guard GDK
</parameter_description>
</parameter>
<parameter name="leave_fn">
<parameter_description> function called to release the guard
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_unicode_to_keyval">
<description>
Convert from a ISO10646 character to a key symbol.


</description>
<parameters>
<parameter name="wc">
<parameter_description> a ISO10646 encoded character
</parameter_description>
</parameter>
</parameters>
<return> the corresponding GDK key symbol, if one exists.
or, if there is no corresponding symbol, 
wc | 0x01000000
</return>
</function>

<function name="gdk_utf8_to_string_target">
<description>
Converts an UTF-8 string into the best possible representation
as a STRING. The representation of characters not in STRING
is not specified; it may be as pseudo-escape sequences
\x{ABCD}, or it may be in some other form of approximation.


</description>
<parameters>
<parameter name="str">
<parameter_description> a UTF-8 string
</parameter_description>
</parameter>
</parameters>
<return> the newly-allocated string, or %NULL if the
conversion failed. (It should not fail for
any properly formed UTF-8 string unless system
limits like memory or file descriptors are exceeded.)
</return>
</function>

<function name="gdk_visual_get_best">
<description>
Get the visual with the most available colors for the default
GDK screen. The return value should not be freed.


</description>
<parameters>
</parameters>
<return> best visual
</return>
</function>

<function name="gdk_visual_get_best_depth">
<description>
Get the best available depth for the default GDK screen.  &quot;Best&quot;
means &quot;largest,&quot; i.e. 32 preferred over 24 preferred over 8 bits
per pixel.


</description>
<parameters>
</parameters>
<return> best available depth
</return>
</function>

<function name="gdk_visual_get_best_type">
<description>
Return the best available visual type for the default GDK screen.


</description>
<parameters>
</parameters>
<return> best visual type
</return>
</function>

<function name="gdk_visual_get_best_with_both">
<description>
Combines gdk_visual_get_best_with_depth() and
gdk_visual_get_best_with_type().


</description>
<parameters>
<parameter name="depth">
<parameter_description> a bit depth
</parameter_description>
</parameter>
<parameter name="visual_type">
<parameter_description> a visual type
</parameter_description>
</parameter>
</parameters>
<return> best visual with both @depth and
@visual_type, or %NULL if none
</return>
</function>

<function name="gdk_visual_get_best_with_depth">
<description>
Get the best visual with depth @depth for the default GDK screen.
Color visuals and visuals with mutable colormaps are preferred
over grayscale or fixed-colormap visuals. The return value should
not be freed. %NULL may be returned if no visual supports @depth.


</description>
<parameters>
<parameter name="depth">
<parameter_description> a bit depth
</parameter_description>
</parameter>
</parameters>
<return> best visual for the given depth
</return>
</function>

<function name="gdk_visual_get_best_with_type">
<description>
Get the best visual of the given @visual_type for the default GDK screen.
Visuals with higher color depths are considered better. The return value
should not be freed. %NULL may be returned if no visual has type
@visual_type.


</description>
<parameters>
<parameter name="visual_type">
<parameter_description> a visual type
</parameter_description>
</parameter>
</parameters>
<return> best visual of the given type
</return>
</function>

<function name="gdk_visual_get_bits_per_rgb">
<description>
Returns the number of significant bits per red, green and blue value.

Since: 2.22

</description>
<parameters>
<parameter name="visual">
<parameter_description> a #GdkVisual
</parameter_description>
</parameter>
</parameters>
<return> The number of significant bits per color value for @visual.

</return>
</function>

<function name="gdk_visual_get_blue_pixel_details">
<description>
Obtains values that are needed to calculate blue pixel values in TrueColor
and DirectColor. The &quot;mask&quot; is the significant bits within the pixel.
The &quot;shift&quot; is the number of bits left we must shift a primary for it
to be in position (according to the &quot;mask&quot;). Finally, &quot;precision&quot; refers
to how much precision the pixel value contains for a particular primary.

Since: 2.22

</description>
<parameters>
<parameter name="visual">
<parameter_description> a #GdkVisual
</parameter_description>
</parameter>
<parameter name="mask">
<parameter_description> A pointer to a #guint32 to be filled in, or %NULL
</parameter_description>
</parameter>
<parameter name="shift">
<parameter_description> A pointer to a #gint to be filled in, or %NULL
</parameter_description>
</parameter>
<parameter name="precision">
<parameter_description> A pointer to a #gint to be filled in, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_visual_get_byte_order">
<description>
Returns the byte order of this visual.

Since: 2.22

</description>
<parameters>
<parameter name="visual">
<parameter_description> A #GdkVisual.
</parameter_description>
</parameter>
</parameters>
<return> A #GdkByteOrder stating the byte order of @visual.

</return>
</function>

<function name="gdk_visual_get_colormap_size">
<description>
Returns the size of a colormap for this visual.

Since: 2.22

</description>
<parameters>
<parameter name="visual">
<parameter_description> A #GdkVisual.
</parameter_description>
</parameter>
</parameters>
<return> The size of a colormap that is suitable for @visual.

</return>
</function>

<function name="gdk_visual_get_depth">
<description>
Returns the bit depth of this visual.

Since: 2.22

</description>
<parameters>
<parameter name="visual">
<parameter_description> A #GdkVisual.
</parameter_description>
</parameter>
</parameters>
<return> The bit depth of this visual.

</return>
</function>

<function name="gdk_visual_get_green_pixel_details">
<description>
Obtains values that are needed to calculate green pixel values in TrueColor
and DirectColor. The &quot;mask&quot; is the significant bits within the pixel.
The &quot;shift&quot; is the number of bits left we must shift a primary for it
to be in position (according to the &quot;mask&quot;). Finally, &quot;precision&quot; refers
to how much precision the pixel value contains for a particular primary.

Since: 2.22

</description>
<parameters>
<parameter name="visual">
<parameter_description> a #GdkVisual
</parameter_description>
</parameter>
<parameter name="mask">
<parameter_description> A pointer to a #guint32 to be filled in, or %NULL
</parameter_description>
</parameter>
<parameter name="shift">
<parameter_description> A pointer to a #gint to be filled in, or %NULL
</parameter_description>
</parameter>
<parameter name="precision">
<parameter_description> A pointer to a #gint to be filled in, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_visual_get_red_pixel_details">
<description>
Obtains values that are needed to calculate red pixel values in TrueColor
and DirectColor. The &quot;mask&quot; is the significant bits within the pixel.
The &quot;shift&quot; is the number of bits left we must shift a primary for it
to be in position (according to the &quot;mask&quot;). Finally, &quot;precision&quot; refers
to how much precision the pixel value contains for a particular primary.

Since: 2.22

</description>
<parameters>
<parameter name="visual">
<parameter_description> A #GdkVisual
</parameter_description>
</parameter>
<parameter name="mask">
<parameter_description> A pointer to a #guint32 to be filled in, or %NULL
</parameter_description>
</parameter>
<parameter name="shift">
<parameter_description> A pointer to a #gint to be filled in, or %NULL
</parameter_description>
</parameter>
<parameter name="precision">
<parameter_description> A pointer to a #gint to be filled in, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_visual_get_screen">
<description>
Gets the screen to which this visual belongs

Since: 2.2

</description>
<parameters>
<parameter name="visual">
<parameter_description> a #GdkVisual
</parameter_description>
</parameter>
</parameters>
<return> the screen to which this visual belongs.

</return>
</function>

<function name="gdk_visual_get_system">
<description>
Get the system's default visual for the default GDK screen.
This is the visual for the root window of the display.
The return value should not be freed.


</description>
<parameters>
</parameters>
<return> system visual
</return>
</function>

<function name="gdk_visual_get_visual_type">
<description>
Returns the type of visual this is (PseudoColor, TrueColor, etc).

Since: 2.22

</description>
<parameters>
<parameter name="visual">
<parameter_description> A #GdkVisual.
</parameter_description>
</parameter>
</parameters>
<return> A #GdkVisualType stating the type of @visual.

</return>
</function>

<function name="gdk_wayland_display_broadcast_startup_message">
<description>
Sends a startup notification message of type @message_type to
@display. 

This is a convenience function for use by code that implements the
freedesktop startup notification specification. Applications should
not normally need to call it directly. See the &lt;ulink
url=&quot;http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt&quot;&gt;Startup
Notification Protocol specification&lt;/ulink&gt; for
definitions of the message types and keys that can be used.

Since: 2.12

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
<parameter name="message_type">
<parameter_description> startup notification message type (&quot;new&quot;, &quot;change&quot;,
or &quot;remove&quot;)
</parameter_description>
</parameter>
<parameter name="Varargs">
<parameter_description> a list of key/value pairs (as strings), terminated by a
%NULL key. (A %NULL value for a key will cause that key to be
skipped in the output.)
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_wayland_display_get_wl_compositor">
<description>
Returns the Wayland global singleton compositor of a #GdkDisplay

Since: 3.8

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return> a Wayland wl_compositor

</return>
</function>

<function name="gdk_wayland_display_get_wl_display">
<description>
Returns the Wayland wl_display of a #GdkDisplay

Since: 3.8

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return> a Wayland wl_display

</return>
</function>

<function name="gdk_wayland_display_get_wl_shell">
<description>
Returns the Wayland global singleton shell of a #GdkDisplay

Since: 3.8

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return> a Wayland wl_shell

</return>
</function>

<function name="gdk_wayland_window_get_wl_shell_surface">
<description>
Returns the Wayland shell surface of a #GdkWindow

Since: 3.8

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> a Wayland wl_shell_surface

</return>
</function>

<function name="gdk_wayland_window_get_wl_surface">
<description>
Returns the Wayland surface of a #GdkWindow

Since: 3.8

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> a Wayland wl_surface

</return>
</function>

<function name="gdk_wayland_window_update_size">
<description>
Updates the state of the drawable (in particular the drawable's
cairo surface) when its size has changed.

</description>
<parameters>
<parameter name="drawable">
<parameter_description> a #GdkDrawableImplWayland.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_add_filter">
<description>
Adds an event filter to @window, allowing you to intercept events
before they reach GDK. This is a low-level operation and makes it
easy to break GDK and/or GTK+, so you have to know what you're
doing. Pass %NULL for @window to get all events for all windows,
instead of events for a specific window.

If you are interested in X GenericEvents, bear in mind that
XGetEventData() has been already called on the event, and
XFreeEventData() must not be called within @function.

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="function">
<parameter_description> filter callback
</parameter_description>
</parameter>
<parameter name="data">
<parameter_description> data to pass to filter callback
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_at_pointer">
<description>
Obtains the window underneath the mouse pointer, returning the
location of that window in @win_x, @win_y. Returns %NULL if the
window under the mouse pointer is not known to GDK (if the window
belongs to another application and a #GdkWindow hasn't been created
for it with gdk_window_foreign_new())

NOTE: For multihead-aware widgets or applications use
gdk_display_get_window_at_pointer() instead.

Deprecated: 3.0: Use gdk_device_get_window_at_position() instead.

</description>
<parameters>
<parameter name="win_x">
<parameter_description> return location for origin of the window under the pointer
</parameter_description>
</parameter>
<parameter name="win_y">
<parameter_description> return location for origin of the window under the pointer
</parameter_description>
</parameter>
</parameters>
<return> window under the mouse pointer

</return>
</function>

<function name="gdk_window_beep">
<description>
Emits a short beep associated to @window in the appropriate
display, if supported. Otherwise, emits a short beep on
the display just as gdk_display_beep().

Since: 2.12

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_begin_move_drag">
<description>
Begins a window move operation (for a toplevel window).

This function assumes that the drag is controlled by the
client pointer device, use gdk_window_begin_move_drag_for_device()
to begin a drag with a different device.

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="button">
<parameter_description> the button being used to drag
</parameter_description>
</parameter>
<parameter name="root_x">
<parameter_description> root window X coordinate of mouse click that began the drag
</parameter_description>
</parameter>
<parameter name="root_y">
<parameter_description> root window Y coordinate of mouse click that began the drag
</parameter_description>
</parameter>
<parameter name="timestamp">
<parameter_description> timestamp of mouse click that began the drag
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_begin_move_drag_for_device">
<description>
Begins a window move operation (for a toplevel window).
You might use this function to implement a &quot;window move grip,&quot; for
example. The function works best with window managers that support
the &lt;ulink url=&quot;http://www.freedesktop.org/Standards/wm-spec&quot;&gt;Extended
Window Manager Hints&lt;/ulink&gt;, but has a fallback implementation for
other window managers.

Since: 3.4

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="device">
<parameter_description> the device used for the operation
</parameter_description>
</parameter>
<parameter name="button">
<parameter_description> the button being used to drag
</parameter_description>
</parameter>
<parameter name="root_x">
<parameter_description> root window X coordinate of mouse click that began the drag
</parameter_description>
</parameter>
<parameter name="root_y">
<parameter_description> root window Y coordinate of mouse click that began the drag
</parameter_description>
</parameter>
<parameter name="timestamp">
<parameter_description> timestamp of mouse click that began the drag
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_begin_paint_rect">
<description>
A convenience wrapper around gdk_window_begin_paint_region() which
creates a rectangular region for you. See
gdk_window_begin_paint_region() for details.


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="rectangle">
<parameter_description> rectangle you intend to draw to
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_begin_paint_region">
<description>
Indicates that you are beginning the process of redrawing @region.
A backing store (offscreen buffer) large enough to contain @region
will be created. The backing store will be initialized with the
background color or background surface for @window. Then, all
drawing operations performed on @window will be diverted to the
backing store.  When you call gdk_window_end_paint(), the backing
store will be copied to @window, making it visible onscreen. Only
the part of @window contained in @region will be modified; that is,
drawing operations are clipped to @region.

The net result of all this is to remove flicker, because the user
sees the finished product appear all at once when you call
gdk_window_end_paint(). If you draw to @window directly without
calling gdk_window_begin_paint_region(), the user may see flicker
as individual drawing operations are performed in sequence.  The
clipping and background-initializing features of
gdk_window_begin_paint_region() are conveniences for the
programmer, so you can avoid doing that work yourself.

When using GTK+, the widget system automatically places calls to
gdk_window_begin_paint_region() and gdk_window_end_paint() around
emissions of the expose_event signal. That is, if you're writing an
expose event handler, you can assume that the exposed area in
#GdkEventExpose has already been cleared to the window background,
is already set as the clip region, and already has a backing store.
Therefore in most cases, application code need not call
gdk_window_begin_paint_region(). (You can disable the automatic
calls around expose events on a widget-by-widget basis by calling
gtk_widget_set_double_buffered().)

If you call this function multiple times before calling the
matching gdk_window_end_paint(), the backing stores are pushed onto
a stack. gdk_window_end_paint() copies the topmost backing store
onscreen, subtracts the topmost region from all other regions in
the stack, and pops the stack. All drawing operations affect only
the topmost backing store in the stack. One matching call to
gdk_window_end_paint() is required for each call to
gdk_window_begin_paint_region().


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="region">
<parameter_description> region you intend to draw to
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_begin_resize_drag">
<description>
Begins a window resize operation (for a toplevel window).

This function assumes that the drag is controlled by the
client pointer device, use gdk_window_begin_resize_drag_for_device()
to begin a drag with a different device.

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="edge">
<parameter_description> the edge or corner from which the drag is started
</parameter_description>
</parameter>
<parameter name="button">
<parameter_description> the button being used to drag
</parameter_description>
</parameter>
<parameter name="root_x">
<parameter_description> root window X coordinate of mouse click that began the drag
</parameter_description>
</parameter>
<parameter name="root_y">
<parameter_description> root window Y coordinate of mouse click that began the drag
</parameter_description>
</parameter>
<parameter name="timestamp">
<parameter_description> timestamp of mouse click that began the drag (use gdk_event_get_time())
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_begin_resize_drag_for_device">
<description>
Begins a window resize operation (for a toplevel window).
You might use this function to implement a &quot;window resize grip,&quot; for
example; in fact #GtkStatusbar uses it. The function works best
with window managers that support the &lt;ulink url=&quot;http://www.freedesktop.org/Standards/wm-spec&quot;&gt;Extended Window Manager Hints&lt;/ulink&gt;, but has a
fallback implementation for other window managers.

Since: 3.4

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="edge">
<parameter_description> the edge or corner from which the drag is started
</parameter_description>
</parameter>
<parameter name="device">
<parameter_description> the device used for the operation
</parameter_description>
</parameter>
<parameter name="button">
<parameter_description> the button being used to drag
</parameter_description>
</parameter>
<parameter name="root_x">
<parameter_description> root window X coordinate of mouse click that began the drag
</parameter_description>
</parameter>
<parameter name="root_y">
<parameter_description> root window Y coordinate of mouse click that began the drag
</parameter_description>
</parameter>
<parameter name="timestamp">
<parameter_description> timestamp of mouse click that began the drag (use gdk_event_get_time())
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_configure_finished">
<description>
Does nothing, present only for compatiblity.

Since: 2.6
Deprecated: 3.8: this function is no longer needed

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_constrain_size">
<description>
Constrains a desired width and height according to a
set of geometry hints (such as minimum and maximum size).

</description>
<parameters>
<parameter name="geometry">
<parameter_description> a #GdkGeometry structure
</parameter_description>
</parameter>
<parameter name="flags">
<parameter_description> a mask indicating what portions of @geometry are set
</parameter_description>
</parameter>
<parameter name="width">
<parameter_description> desired width of window
</parameter_description>
</parameter>
<parameter name="height">
<parameter_description> desired height of the window
</parameter_description>
</parameter>
<parameter name="new_width">
<parameter_description> location to store resulting width
</parameter_description>
</parameter>
<parameter name="new_height">
<parameter_description> location to store resulting height
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_coords_from_parent">
<description>
Transforms window coordinates from a parent window to a child
window, where the parent window is the normal parent as returned by
gdk_window_get_parent() for normal windows, and the window's
embedder as returned by gdk_offscreen_window_get_embedder() for
offscreen windows.

For normal windows, calling this function is equivalent to subtracting
the return values of gdk_window_get_position() from the parent coordinates.
For offscreen windows however (which can be arbitrarily transformed),
this function calls the GdkWindow::from-embedder: signal to translate
the coordinates.

You should always use this function when writing generic code that
walks down a window hierarchy.

See also: gdk_window_coords_to_parent()

Since: 2.22

</description>
<parameters>
<parameter name="window">
<parameter_description> a child window
</parameter_description>
</parameter>
<parameter name="parent_x">
<parameter_description> X coordinate in parent's coordinate system
</parameter_description>
</parameter>
<parameter name="parent_y">
<parameter_description> Y coordinate in parent's coordinate system
</parameter_description>
</parameter>
<parameter name="x">
<parameter_description> return location for X coordinate in child's coordinate system
</parameter_description>
</parameter>
<parameter name="y">
<parameter_description> return location for Y coordinate in child's coordinate system
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_coords_to_parent">
<description>
Transforms window coordinates from a child window to its parent
window, where the parent window is the normal parent as returned by
gdk_window_get_parent() for normal windows, and the window's
embedder as returned by gdk_offscreen_window_get_embedder() for
offscreen windows.

For normal windows, calling this function is equivalent to adding
the return values of gdk_window_get_position() to the child coordinates.
For offscreen windows however (which can be arbitrarily transformed),
this function calls the GdkWindow::to-embedder: signal to translate
the coordinates.

You should always use this function when writing generic code that
walks up a window hierarchy.

See also: gdk_window_coords_from_parent()

Since: 2.22

</description>
<parameters>
<parameter name="window">
<parameter_description> a child window
</parameter_description>
</parameter>
<parameter name="x">
<parameter_description> X coordinate in child's coordinate system
</parameter_description>
</parameter>
<parameter name="y">
<parameter_description> Y coordinate in child's coordinate system
</parameter_description>
</parameter>
<parameter name="parent_x">
<parameter_description> return location for X coordinate
in parent's coordinate system, or %NULL
</parameter_description>
</parameter>
<parameter name="parent_y">
<parameter_description> return location for Y coordinate
in parent's coordinate system, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_create_similar_surface">
<description>
Create a new surface that is as compatible as possible with the
given @window. For example the new surface will have the same
fallback resolution and font options as @window. Generally, the new
surface will also use the same backend as @window, unless that is
not possible for some reason. The type of the returned surface may
be examined with cairo_surface_get_type().

Initially the surface contents are all 0 (transparent if contents
have transparency, black otherwise.)

Since: 2.22

</description>
<parameters>
<parameter name="window">
<parameter_description> window to make new surface similar to
</parameter_description>
</parameter>
<parameter name="content">
<parameter_description> the content for the new surface
</parameter_description>
</parameter>
<parameter name="width">
<parameter_description> width of the new surface
</parameter_description>
</parameter>
<parameter name="height">
<parameter_description> height of the new surface
</parameter_description>
</parameter>
</parameters>
<return> a pointer to the newly allocated surface. The caller
owns the surface and should call cairo_surface_destroy() when done
with it.

This function always returns a valid pointer, but it will return a
pointer to a &quot;nil&quot; surface if @other is already in an error state
or any other error occurs.

</return>
</function>

<function name="gdk_window_deiconify">
<description>
Attempt to deiconify (unminimize) @window. On X11 the window manager may
choose to ignore the request to deiconify. When using GTK+,
use gtk_window_deiconify() instead of the #GdkWindow variant. Or better yet,
you probably want to use gtk_window_present(), which raises the window, focuses it,
unminimizes it, and puts it on the current desktop.


</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_destroy">
<description>
Destroys the window system resources associated with @window and decrements @window's
reference count. The window system resources for all children of @window are also
destroyed, but the children's reference counts are not decremented.

Note that a window will not be destroyed automatically when its reference count
reaches zero. You must call this function yourself before that happens.


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_enable_synchronized_configure">
<description>
Does nothing, present only for compatiblity.

Since: 2.6
Deprecated: 3.8: this function is no longer needed

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_end_paint">
<description>
Indicates that the backing store created by the most recent call to
gdk_window_begin_paint_region() should be copied onscreen and
deleted, leaving the next-most-recent backing store or no backing
store at all as the active paint region. See
gdk_window_begin_paint_region() for full details. It is an error to
call this function without a matching
gdk_window_begin_paint_region() first.


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_ensure_native">
<description>
Tries to ensure that there is a window-system native window for this
GdkWindow. This may fail in some situations, returning %FALSE.

Offscreen window and children of them can never have native windows.

Some backends may not support native child windows.

Since: 2.18

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the window has a native window, %FALSE otherwise

</return>
</function>

<function name="gdk_window_flush">
<description>
Flush all outstanding cached operations on a window, leaving the
window in a state which reflects all that has been drawn before.

Gdk uses multiple kinds of caching to get better performance and
nicer drawing. For instance, during exposes all paints to a window
using double buffered rendering are keep on a surface until the last
window has been exposed. It also delays window moves/scrolls until
as long as possible until next update to avoid tearing when moving
windows.

Normally this should be completely invisible to applications, as
we automatically flush the windows when required, but this might
be needed if you for instance mix direct native drawing with
gdk drawing. For Gtk widgets that don't use double buffering this
will be called automatically before sending the expose event.

Since: 2.18

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_focus">
<description>
Sets keyboard focus to @window. In most cases, gtk_window_present()
should be used on a #GtkWindow, rather than calling this function.


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="timestamp">
<parameter_description> timestamp of the event triggering the window focus
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_freeze_toplevel_updates_libgtk_only">
<description>
Temporarily freezes a window and all its descendants such that it won't
receive expose events.  The window will begin receiving expose events
again when gdk_window_thaw_toplevel_updates_libgtk_only() is called. If
gdk_window_freeze_toplevel_updates_libgtk_only()
has been called more than once,
gdk_window_thaw_toplevel_updates_libgtk_only() must be called
an equal number of times to begin processing exposes.

This function is not part of the GDK public API and is only
for use by GTK+.

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_freeze_updates">
<description>
Temporarily freezes a window such that it won't receive expose
events.  The window will begin receiving expose events again when
gdk_window_thaw_updates() is called. If gdk_window_freeze_updates()
has been called more than once, gdk_window_thaw_updates() must be called
an equal number of times to begin processing exposes.

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_fullscreen">
<description>
Moves the window into fullscreen mode. This means the
window covers the entire screen and is above any panels
or task bars.

If the window was already fullscreen, then this function does nothing.

On X11, asks the window manager to put @window in a fullscreen
state, if the window manager supports this operation. Not all
window managers support this, and some deliberately ignore it or
don't have a concept of &quot;fullscreen&quot;; so you can't rely on the
fullscreenification actually happening. But it will happen with
most standard window managers, and GDK makes a best effort to get
it to happen.

Since: 2.2

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_geometry_changed">
<description>
This function informs GDK that the geometry of an embedded
offscreen window has changed. This is necessary for GDK to keep
track of which offscreen window the pointer is in.

Since: 2.18

</description>
<parameters>
<parameter name="window">
<parameter_description> an embedded offscreen #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_get_accept_focus">
<description>
Determines whether or not the desktop environment shuld be hinted that
the window does not want to receive input focus.

Since: 2.22

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow.
</parameter_description>
</parameter>
</parameters>
<return> whether or not the window should receive input focus.

</return>
</function>

<function name="gdk_window_get_background_pattern">
<description>
Gets the pattern used to clear the background on @window. If @window
does not have its own background and reuses the parent's, %NULL is
returned and you'll have to query it yourself.

Since: 2.22

</description>
<parameters>
<parameter name="window">
<parameter_description> a window
</parameter_description>
</parameter>
</parameters>
<return> The pattern to use for the background or
%NULL to use the parent's background.

</return>
</function>

<function name="gdk_window_get_children">
<description>
Gets the list of children of @window known to GDK.
This function only returns children created via GDK,
so for example it's useless when used with the root window;
it only returns windows an application created itself.

The returned list must be freed, but the elements in the
list need not be.


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return>
list of child windows inside @window
</return>
</function>

<function name="gdk_window_get_clip_region">
<description>
Computes the region of a window that potentially can be written
to by drawing primitives. This region may not take into account
other factors such as if the window is obscured by other windows,
but no area outside of this region will be affected by drawing
primitives.


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> a #cairo_region_t. This must be freed with cairo_region_destroy()
when you are done.
</return>
</function>

<function name="gdk_window_get_composited">
<description>
Determines whether @window is composited.

See gdk_window_set_composited().

Since: 2.22

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the window is composited.

</return>
</function>

<function name="gdk_window_get_cursor">
<description>
Retrieves a #GdkCursor pointer for the cursor currently set on the
specified #GdkWindow, or %NULL.  If the return value is %NULL then
there is no custom cursor set on the specified window, and it is
using the cursor for its parent window.

Since: 2.18

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> a #GdkCursor, or %NULL. The returned
object is owned by the #GdkWindow and should not be unreferenced
directly. Use gdk_window_set_cursor() to unset the cursor of the
window

</return>
</function>

<function name="gdk_window_get_decorations">
<description>
Returns the decorations set on the GdkWindow with
gdk_window_set_decorations().


</description>
<parameters>
<parameter name="window">
<parameter_description> The toplevel #GdkWindow to get the decorations from
</parameter_description>
</parameter>
<parameter name="decorations">
<parameter_description> The window decorations will be written here
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the window has decorations set, %FALSE otherwise.
</return>
</function>

<function name="gdk_window_get_device_cursor">
<description>
Retrieves a #GdkCursor pointer for the @device currently set on the
specified #GdkWindow, or %NULL.  If the return value is %NULL then
there is no custom cursor set on the specified window, and it is
using the cursor for its parent window.

Since: 3.0

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow.
</parameter_description>
</parameter>
<parameter name="device">
<parameter_description> a master, pointer #GdkDevice.
</parameter_description>
</parameter>
</parameters>
<return> a #GdkCursor, or %NULL. The returned
object is owned by the #GdkWindow and should not be unreferenced
directly. Use gdk_window_set_cursor() to unset the cursor of the
window

</return>
</function>

<function name="gdk_window_get_device_events">
<description>
Returns the event mask for @window corresponding to an specific device.

Since: 3.0

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow.
</parameter_description>
</parameter>
<parameter name="device">
<parameter_description> a #GdkDevice.
</parameter_description>
</parameter>
</parameters>
<return> device event mask for @window

</return>
</function>

<function name="gdk_window_get_device_position">
<description>
Obtains the current device position and modifier state.
The position is given in coordinates relative to the upper left
corner of @window.

Since: 3.0

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow.
</parameter_description>
</parameter>
<parameter name="device">
<parameter_description> pointer #GdkDevice to query to.
</parameter_description>
</parameter>
<parameter name="x">
<parameter_description> return location for the X coordinate of @device, or %NULL.
</parameter_description>
</parameter>
<parameter name="y">
<parameter_description> return location for the Y coordinate of @device, or %NULL.
</parameter_description>
</parameter>
<parameter name="mask">
<parameter_description> return location for the modifier mask, or %NULL.
</parameter_description>
</parameter>
</parameters>
<return> The window underneath @device (as with
gdk_device_get_window_at_position()), or %NULL if the window is not known to GDK.

</return>
</function>

<function name="gdk_window_get_display">
<description>
Gets the #GdkDisplay associated with a #GdkWindow.

Since: 2.24

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> the #GdkDisplay associated with @window

</return>
</function>

<function name="gdk_window_get_drag_protocol">
<description>
Finds out the DND protocol supported by a window.

Since: 3.0

</description>
<parameters>
<parameter name="window">
<parameter_description> the destination window
</parameter_description>
</parameter>
<parameter name="target">
<parameter_description> location of the window
where the drop should happen. This may be @window or a proxy window,
or %NULL if @window does not support Drag and Drop.
</parameter_description>
</parameter>
</parameters>
<return> the supported DND protocol.

</return>
</function>

<function name="gdk_window_get_effective_parent">
<description>
Obtains the parent of @window, as known to GDK. Works like
gdk_window_get_parent() for normal windows, but returns the
window's embedder for offscreen windows.

See also: gdk_offscreen_window_get_embedder()

Since: 2.22

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> effective parent of @window

</return>
</function>

<function name="gdk_window_get_effective_toplevel">
<description>
Gets the toplevel window that's an ancestor of @window.

Works like gdk_window_get_toplevel(), but treats an offscreen window's
embedder as its parent, using gdk_window_get_effective_parent().

See also: gdk_offscreen_window_get_embedder()

Since: 2.22

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> the effective toplevel window containing @window

</return>
</function>

<function name="gdk_window_get_events">
<description>
Gets the event mask for @window for all master input devices. See
gdk_window_set_events().


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> event mask for @window
</return>
</function>

<function name="gdk_window_get_focus_on_map">
<description>
Determines whether or not the desktop environment should be hinted that the
window does not want to receive input focus when it is mapped.

Since: 2.22

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow.
</parameter_description>
</parameter>
</parameters>
<return> whether or not the window wants to receive input focus when
it is mapped.

</return>
</function>

<function name="gdk_window_get_frame_clock">
<description>
Gets the frame clock for the window. The frame clock for a window
never changes unless the window is reparented to a new toplevel
window.

Since: 3.8

</description>
<parameters>
<parameter name="window">
<parameter_description> window to get frame clock for
</parameter_description>
</parameter>
</parameters>
<return> the frame clock
</return>
</function>

<function name="gdk_window_get_frame_extents">
<description>
Obtains the bounding box of the window, including window manager
titlebar/borders if any. The frame position is given in root window
coordinates. To get the position of the window itself (rather than
the frame) in root window coordinates, use gdk_window_get_origin().


</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="rect">
<parameter_description> rectangle to fill with bounding box of the window frame
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_get_fullscreen_mode">
<description>
Obtains the #GdkFullscreenMode of the @window.

Since: 3.8

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> The #GdkFullscreenMode applied to the window when fullscreen.

</return>
</function>

<function name="gdk_window_get_geometry">
<description>
Any of the return location arguments to this function may be %NULL,
if you aren't interested in getting the value of that field.

The X and Y coordinates returned are relative to the parent window
of @window, which for toplevels usually means relative to the
window decorations (titlebar, etc.) rather than relative to the
root window (screen-size background window).

On the X11 platform, the geometry is obtained from the X server,
so reflects the latest position of @window; this may be out-of-sync
with the position of @window delivered in the most-recently-processed
#GdkEventConfigure. gdk_window_get_position() in contrast gets the
position from the most recent configure event.

&lt;note&gt;
If @window is not a toplevel, it is &lt;emphasis&gt;much&lt;/emphasis&gt; better
to call gdk_window_get_position(), gdk_window_get_width() and
gdk_window_get_height() instead, because it avoids the roundtrip to
the X server and because these functions support the full 32-bit
coordinate space, whereas gdk_window_get_geometry() is restricted to
the 16-bit coordinates of X11.
&lt;/note&gt;

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="x">
<parameter_description> return location for X coordinate of window (relative to its parent)
</parameter_description>
</parameter>
<parameter name="y">
<parameter_description> return location for Y coordinate of window (relative to its parent)
</parameter_description>
</parameter>
<parameter name="width">
<parameter_description> return location for width of window
</parameter_description>
</parameter>
<parameter name="height">
<parameter_description> return location for height of window
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_get_group">
<description>
Returns the group leader window for @window. See gdk_window_set_group().

Since: 2.4

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> the group leader window for @window

</return>
</function>

<function name="gdk_window_get_height">
<description>
Returns the height of the given @window.

On the X11 platform the returned size is the size reported in the
most-recently-processed configure event, rather than the current
size on the X server.

Since: 2.24

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> The height of @window

</return>
</function>

<function name="gdk_window_get_modal_hint">
<description>
Determines whether or not the window manager is hinted that @window
has modal behaviour.

Since: 2.22

</description>
<parameters>
<parameter name="window">
<parameter_description> A toplevel #GdkWindow.
</parameter_description>
</parameter>
</parameters>
<return> whether or not the window has the modal hint set.

</return>
</function>

<function name="gdk_window_get_origin">
<description>
Obtains the position of a window in root window coordinates.
(Compare with gdk_window_get_position() and
gdk_window_get_geometry() which return the position of a window
relative to its parent window.)


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="x">
<parameter_description> return location for X coordinate
</parameter_description>
</parameter>
<parameter name="y">
<parameter_description> return location for Y coordinate
</parameter_description>
</parameter>
</parameters>
<return> not meaningful, ignore
</return>
</function>

<function name="gdk_window_get_parent">
<description>
Obtains the parent of @window, as known to GDK. Does not query the
X server; thus this returns the parent as passed to gdk_window_new(),
not the actual parent. This should never matter unless you're using
Xlib calls mixed with GDK calls on the X11 platform. It may also
matter for toplevel windows, because the window manager may choose
to reparent them.

Note that you should use gdk_window_get_effective_parent() when
writing generic code that walks up a window hierarchy, because
gdk_window_get_parent() will most likely not do what you expect if
there are offscreen windows in the hierarchy.


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> parent of @window
</return>
</function>

<function name="gdk_window_get_pointer">
<description>
Obtains the current pointer position and modifier state.
The position is given in coordinates relative to the upper left
corner of @window.

Deprecated: 3.0: Use gdk_window_get_device_position() instead.

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="x">
<parameter_description> return location for X coordinate of pointer or %NULL to not
return the X coordinate
</parameter_description>
</parameter>
<parameter name="y">
<parameter_description>  return location for Y coordinate of pointer or %NULL to not
return the Y coordinate
</parameter_description>
</parameter>
<parameter name="mask">
<parameter_description> return location for modifier mask or %NULL to not return the
modifier mask
</parameter_description>
</parameter>
</parameters>
<return> the window containing the pointer (as with
gdk_window_at_pointer()), or %NULL if the window containing the
pointer isn't known to GDK

</return>
</function>

<function name="gdk_window_get_position">
<description>
Obtains the position of the window as reported in the
most-recently-processed #GdkEventConfigure. Contrast with
gdk_window_get_geometry() which queries the X server for the
current window position, regardless of which events have been
received or processed.

The position coordinates are relative to the window's parent window.


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="x">
<parameter_description> X coordinate of window
</parameter_description>
</parameter>
<parameter name="y">
<parameter_description> Y coordinate of window
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_get_root_coords">
<description>
Obtains the position of a window position in root
window coordinates. This is similar to
gdk_window_get_origin() but allows you go pass
in any position in the window, not just the origin.

Since: 2.18

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="x">
<parameter_description> X coordinate in window
</parameter_description>
</parameter>
<parameter name="y">
<parameter_description> Y coordinate in window
</parameter_description>
</parameter>
<parameter name="root_x">
<parameter_description> return location for X coordinate
</parameter_description>
</parameter>
<parameter name="root_y">
<parameter_description> return location for Y coordinate
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_get_root_origin">
<description>
Obtains the top-left corner of the window manager frame in root
window coordinates.


</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="x">
<parameter_description> return location for X position of window frame
</parameter_description>
</parameter>
<parameter name="y">
<parameter_description> return location for Y position of window frame
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_get_screen">
<description>
Gets the #GdkScreen associated with a #GdkWindow.

Since: 2.24

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> the #GdkScreen associated with @window

</return>
</function>

<function name="gdk_window_get_source_events">
<description>
Returns the event mask for @window corresponding to the device class specified
by @source.


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="source">
<parameter_description> a #GdkInputSource to define the source class.
</parameter_description>
</parameter>
</parameters>
<return> source event mask for @window
</return>
</function>

<function name="gdk_window_get_state">
<description>
Gets the bitwise OR of the currently active window state flags,
from the #GdkWindowState enumeration.


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> window state bitfield
</return>
</function>

<function name="gdk_window_get_support_multidevice">
<description>
Returns %TRUE if the window is aware of the existence of multiple
devices.

Since: 3.0

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow.
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the window handles multidevice features.

</return>
</function>

<function name="gdk_window_get_toplevel">
<description>
Gets the toplevel window that's an ancestor of @window.

Any window type but %GDK_WINDOW_CHILD is considered a
toplevel window, as is a %GDK_WINDOW_CHILD window that
has a root window as parent.

Note that you should use gdk_window_get_effective_toplevel() when
you want to get to a window's toplevel as seen on screen, because
gdk_window_get_toplevel() will most likely not do what you expect
if there are offscreen windows in the hierarchy.


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> the toplevel window containing @window
</return>
</function>

<function name="gdk_window_get_type_hint">
<description>
This function returns the type hint set for a window.

Since: 2.10

</description>
<parameters>
<parameter name="window">
<parameter_description> A toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> The type hint set for @window

</return>
</function>

<function name="gdk_window_get_update_area">
<description>
Transfers ownership of the update area from @window to the caller
of the function. That is, after calling this function, @window will
no longer have an invalid/dirty region; the update area is removed
from @window and handed to you. If a window has no update area,
gdk_window_get_update_area() returns %NULL. You are responsible for
calling cairo_region_destroy() on the returned region if it's non-%NULL.


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> the update area for @window
</return>
</function>

<function name="gdk_window_get_user_data">
<description>
Retrieves the user data for @window, which is normally the widget
that @window belongs to. See gdk_window_set_user_data().


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="data">
<parameter_description> return location for user data
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_get_visible_region">
<description>
Computes the region of the @window that is potentially visible.
This does not necessarily take into account if the window is
obscured by other windows, but no area outside of this region
is visible.


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> a #cairo_region_t. This must be freed with cairo_region_destroy()
when you are done.
</return>
</function>

<function name="gdk_window_get_visual">
<description>
Gets the #GdkVisual describing the pixel format of @window.

Since: 2.24

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> a #GdkVisual

</return>
</function>

<function name="gdk_window_get_width">
<description>
Returns the width of the given @window.

On the X11 platform the returned size is the size reported in the
most-recently-processed configure event, rather than the current
size on the X server.

Since: 2.24

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> The width of @window

</return>
</function>

<function name="gdk_window_get_window_type">
<description>
Gets the type of the window. See #GdkWindowType.


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> type of window
</return>
</function>

<function name="gdk_window_has_native">
<description>
Checks whether the window has a native window or not. Note that
you can use gdk_window_ensure_native() if a native window is needed.

Since: 2.22

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the %window has a native window, %FALSE otherwise.

</return>
</function>

<function name="gdk_window_hide">
<description>
For toplevel windows, withdraws them, so they will no longer be
known to the window manager; for all windows, unmaps them, so
they won't be displayed. Normally done automatically as
part of gtk_widget_hide().

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_iconify">
<description>
Asks to iconify (minimize) @window. The window manager may choose
to ignore the request, but normally will honor it. Using
gtk_window_iconify() is preferred, if you have a #GtkWindow widget.

This function only makes sense when @window is a toplevel window.


</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_input_shape_combine_region">
<description>
Like gdk_window_shape_combine_region(), but the shape applies
only to event handling. Mouse events which happen while
the pointer position corresponds to an unset bit in the
mask will be passed on the window below @window.

An input shape is typically used with RGBA windows.
The alpha channel of the window defines which pixels are
invisible and allows for nicely antialiased borders,
and the input shape controls where the window is
&quot;clickable&quot;.

On the X11 platform, this requires version 1.1 of the
shape extension.

On the Win32 platform, this functionality is not present and the
function does nothing.

Since: 2.10

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="shape_region">
<parameter_description> region of window to be non-transparent
</parameter_description>
</parameter>
<parameter name="offset_x">
<parameter_description> X position of @shape_region in @window coordinates
</parameter_description>
</parameter>
<parameter name="offset_y">
<parameter_description> Y position of @shape_region in @window coordinates
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_invalidate_maybe_recurse">
<description>
Adds @region to the update area for @window. The update area is the
region that needs to be redrawn, or &quot;dirty region.&quot; The call
gdk_window_process_updates() sends one or more expose events to the
window, which together cover the entire update area. An
application would normally redraw the contents of @window in
response to those expose events.

GDK will call gdk_window_process_all_updates() on your behalf
whenever your program returns to the main loop and becomes idle, so
normally there's no need to do that manually, you just need to
invalidate regions that you know should be redrawn.

The @child_func parameter controls whether the region of
each child window that intersects @region will also be invalidated.
Only children for which @child_func returns TRUE will have the area
invalidated.

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="region">
<parameter_description> a #cairo_region_t
</parameter_description>
</parameter>
<parameter name="child_func">
<parameter_description> function to use to decide if to
recurse to a child, %NULL means never recurse.
</parameter_description>
</parameter>
<parameter name="user_data">
<parameter_description> data passed to @child_func
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_invalidate_rect">
<description>
A convenience wrapper around gdk_window_invalidate_region() which
invalidates a rectangular region. See
gdk_window_invalidate_region() for details.

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="rect">
<parameter_description> rectangle to invalidate or %NULL to invalidate the whole
window
</parameter_description>
</parameter>
<parameter name="invalidate_children">
<parameter_description> whether to also invalidate child windows
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_invalidate_region">
<description>
Adds @region to the update area for @window. The update area is the
region that needs to be redrawn, or &quot;dirty region.&quot; The call
gdk_window_process_updates() sends one or more expose events to the
window, which together cover the entire update area. An
application would normally redraw the contents of @window in
response to those expose events.

GDK will call gdk_window_process_all_updates() on your behalf
whenever your program returns to the main loop and becomes idle, so
normally there's no need to do that manually, you just need to
invalidate regions that you know should be redrawn.

The @invalidate_children parameter controls whether the region of
each child window that intersects @region will also be invalidated.
If %FALSE, then the update area for child windows will remain
unaffected. See gdk_window_invalidate_maybe_recurse if you need
fine grained control over which children are invalidated.

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="region">
<parameter_description> a #cairo_region_t
</parameter_description>
</parameter>
<parameter name="invalidate_children">
<parameter_description> %TRUE to also invalidate child windows
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_is_destroyed">
<description>
Check to see if a window is destroyed..

Since: 2.18

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the window is destroyed

</return>
</function>

<function name="gdk_window_is_input_only">
<description>
Determines whether or not the window is an input only window.

Since: 2.22

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if @window is input only

</return>
</function>

<function name="gdk_window_is_shaped">
<description>
Determines whether or not the window is shaped.

Since: 2.22

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if @window is shaped

</return>
</function>

<function name="gdk_window_is_viewable">
<description>
Check if the window and all ancestors of the window are
mapped. (This is not necessarily &quot;viewable&quot; in the X sense, since
we only check as far as we have GDK window parents, not to the root
window.)


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the window is viewable
</return>
</function>

<function name="gdk_window_is_visible">
<description>
Checks whether the window has been mapped (with gdk_window_show() or
gdk_window_show_unraised()).


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the window is mapped
</return>
</function>

<function name="gdk_window_lower">
<description>
Lowers @window to the bottom of the Z-order (stacking order), so that
other windows with the same parent window appear above @window.
This is true whether or not the other windows are visible.

If @window is a toplevel, the window manager may choose to deny the
request to move the window in the Z-order, gdk_window_lower() only
requests the restack, does not guarantee it.

Note that gdk_window_show() raises the window again, so don't call this
function before gdk_window_show(). (Try gdk_window_show_unraised().)

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_maximize">
<description>
Maximizes the window. If the window was already maximized, then
this function does nothing.

On X11, asks the window manager to maximize @window, if the window
manager supports this operation. Not all window managers support
this, and some deliberately ignore it or don't have a concept of
&quot;maximized&quot;; so you can't rely on the maximization actually
happening. But it will happen with most standard window managers,
and GDK makes a best effort to get it to happen.

On Windows, reliably maximizes the window.


</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_merge_child_input_shapes">
<description>
Merges the input shape masks for any child windows into the
input shape mask for @window. i.e. the union of all input masks
for @window and its children will become the new input mask
for @window. See gdk_window_input_shape_combine_region().

This function is distinct from gdk_window_set_child_input_shapes()
because it includes @window's input shape mask in the set of
shapes to be merged.

Since: 2.10

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_merge_child_shapes">
<description>
Merges the shape masks for any child windows into the
shape mask for @window. i.e. the union of all masks
for @window and its children will become the new mask
for @window. See gdk_window_shape_combine_region().

This function is distinct from gdk_window_set_child_shapes()
because it includes @window's shape mask in the set of shapes to
be merged.

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_move">
<description>
Repositions a window relative to its parent window.
For toplevel windows, window managers may ignore or modify the move;
you should probably use gtk_window_move() on a #GtkWindow widget
anyway, instead of using GDK functions. For child windows,
the move will reliably succeed.

If you're also planning to resize the window, use gdk_window_move_resize()
to both move and resize simultaneously, for a nicer visual effect.

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="x">
<parameter_description> X coordinate relative to window's parent
</parameter_description>
</parameter>
<parameter name="y">
<parameter_description> Y coordinate relative to window's parent
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_move_region">
<description>
Move the part of @window indicated by @region by @dy pixels in the Y
direction and @dx pixels in the X direction. The portions of @region
that not covered by the new position of @region are invalidated.

Child windows are not moved.

Since: 2.8

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="region">
<parameter_description> The #cairo_region_t to move
</parameter_description>
</parameter>
<parameter name="dx">
<parameter_description> Amount to move in the X direction
</parameter_description>
</parameter>
<parameter name="dy">
<parameter_description> Amount to move in the Y direction
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_move_resize">
<description>
Equivalent to calling gdk_window_move() and gdk_window_resize(),
except that both operations are performed at once, avoiding strange
visual effects. (i.e. the user may be able to see the window first
move, then resize, if you don't use gdk_window_move_resize().)

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="x">
<parameter_description> new X position relative to window's parent
</parameter_description>
</parameter>
<parameter name="y">
<parameter_description> new Y position relative to window's parent
</parameter_description>
</parameter>
<parameter name="width">
<parameter_description> new width
</parameter_description>
</parameter>
<parameter name="height">
<parameter_description> new height
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_new">
<description>
Creates a new #GdkWindow using the attributes from
@attributes. See #GdkWindowAttr and #GdkWindowAttributesType for
more details.  Note: to use this on displays other than the default
display, @parent must be specified.


</description>
<parameters>
<parameter name="parent">
<parameter_description> a #GdkWindow, or %NULL to create the window as a child of
the default root window for the default display.
</parameter_description>
</parameter>
<parameter name="attributes">
<parameter_description> attributes of the new window
</parameter_description>
</parameter>
<parameter name="attributes_mask">
<parameter_description> mask indicating which
fields in @attributes are valid
</parameter_description>
</parameter>
</parameters>
<return> the new #GdkWindow
</return>
</function>

<function name="gdk_window_peek_children">
<description>
Like gdk_window_get_children(), but does not copy the list of
children, so the list does not need to be freed.


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return>
a reference to the list of child windows in @window
</return>
</function>

<function name="gdk_window_process_all_updates">
<description>
Calls gdk_window_process_updates() for all windows (see #GdkWindow)
in the application.


</description>
<parameters>
</parameters>
<return></return>
</function>

<function name="gdk_window_process_updates">
<description>
Sends one or more expose events to @window. The areas in each
expose event will cover the entire update area for the window (see
gdk_window_invalidate_region() for details). Normally GDK calls
gdk_window_process_all_updates() on your behalf, so there's no
need to call this function unless you want to force expose events
to be delivered immediately and synchronously (vs. the usual
case, where GDK delivers them in an idle handler). Occasionally
this is useful to produce nicer scrolling behavior, for example.


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="update_children">
<parameter_description> whether to also process updates for child windows
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_raise">
<description>
Raises @window to the top of the Z-order (stacking order), so that
other windows with the same parent window appear below @window.
This is true whether or not the windows are visible.

If @window is a toplevel, the window manager may choose to deny the
request to move the window in the Z-order, gdk_window_raise() only
requests the restack, does not guarantee it.

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_register_dnd">
<description>
Registers a window as a potential drop destination.

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_remove_filter">
<description>
Remove a filter previously added with gdk_window_add_filter().

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="function">
<parameter_description> previously-added filter function
</parameter_description>
</parameter>
<parameter name="data">
<parameter_description> user data for previously-added filter function
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_reparent">
<description>
Reparents @window into the given @new_parent. The window being
reparented will be unmapped as a side effect.


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="new_parent">
<parameter_description> new parent to move @window into
</parameter_description>
</parameter>
<parameter name="x">
<parameter_description> X location inside the new parent
</parameter_description>
</parameter>
<parameter name="y">
<parameter_description> Y location inside the new parent
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_resize">
<description>
Resizes @window; for toplevel windows, asks the window manager to resize
the window. The window manager may not allow the resize. When using GTK+,
use gtk_window_resize() instead of this low-level GDK function.

Windows may not be resized below 1x1.

If you're also planning to move the window, use gdk_window_move_resize()
to both move and resize simultaneously, for a nicer visual effect.

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="width">
<parameter_description> new width of the window
</parameter_description>
</parameter>
<parameter name="height">
<parameter_description> new height of the window
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_restack">
<description>
Changes the position of  @window in the Z-order (stacking order), so that
it is above @sibling (if @above is %TRUE) or below @sibling (if @above is
%FALSE).

If @sibling is %NULL, then this either raises (if @above is %TRUE) or
lowers the window.

If @window is a toplevel, the window manager may choose to deny the
request to move the window in the Z-order, gdk_window_restack() only
requests the restack, does not guarantee it.

Since: 2.18

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="sibling">
<parameter_description> a #GdkWindow that is a sibling of @window, or %NULL
</parameter_description>
</parameter>
<parameter name="above">
<parameter_description> a boolean
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_scroll">
<description>
Scroll the contents of @window, both pixels and children, by the
given amount. @window itself does not move. Portions of the window
that the scroll operation brings in from offscreen areas are
invalidated. The invalidated region may be bigger than what would
strictly be necessary.

For X11, a minimum area will be invalidated if the window has no
subwindows, or if the edges of the window's parent do not extend
beyond the edges of the window. In other cases, a multi-step process
is used to scroll the window which may produce temporary visual
artifacts and unnecessary invalidations.

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="dx">
<parameter_description> Amount to scroll in the X direction
</parameter_description>
</parameter>
<parameter name="dy">
<parameter_description> Amount to scroll in the Y direction
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_accept_focus">
<description>
Setting @accept_focus to %FALSE hints the desktop environment that the
window doesn't want to receive input focus.

On X, it is the responsibility of the window manager to interpret this
hint. ICCCM-compliant window manager usually respect it.

Since: 2.4

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="accept_focus">
<parameter_description> %TRUE if the window should receive input focus
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_background">
<description>
Sets the background color of @window. (However, when using GTK+,
set the background of a widget with gtk_widget_modify_bg() - if
you're an application - or gtk_style_set_background() - if you're
implementing a custom widget.)

See also gdk_window_set_background_pattern().

Deprecated: 3.4: Use gdk_window_set_background_rgba() instead.

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="color">
<parameter_description> a #GdkColor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_background_pattern">
<description>
Sets the background of @window.

A background of %NULL means that the window will inherit its
background form its parent window.

The windowing system will normally fill a window with its background
when the window is obscured then exposed.

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="pattern">
<parameter_description> a pattern to use, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_background_rgba">
<description>
Sets the background color of @window.

See also gdk_window_set_background_pattern().

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="rgba">
<parameter_description> a #GdkRGBA color
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_child_input_shapes">
<description>
Sets the input shape mask of @window to the union of input shape masks
for all children of @window, ignoring the input shape mask of @window
itself. Contrast with gdk_window_merge_child_input_shapes() which includes
the input shape mask of @window in the masks to be merged.

Since: 2.10

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_child_shapes">
<description>
Sets the shape mask of @window to the union of shape masks
for all children of @window, ignoring the shape mask of @window
itself. Contrast with gdk_window_merge_child_shapes() which includes
the shape mask of @window in the masks to be merged.

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_composited">
<description>
Sets a #GdkWindow as composited, or unsets it. Composited
windows do not automatically have their contents drawn to
the screen. Drawing is redirected to an offscreen buffer
and an expose event is emitted on the parent of the composited
window. It is the responsibility of the parent's expose handler
to manually merge the off-screen content onto the screen in
whatever way it sees fit. See &lt;xref linkend=&quot;composited-window-example&quot;/&gt;
for an example.

It only makes sense for child windows to be composited; see
gdk_window_set_opacity() if you need translucent toplevel
windows.

An additional effect of this call is that the area of this
window is no longer clipped from regions marked for
invalidation on its parent. Draws done on the parent
window are also no longer clipped by the child.

This call is only supported on some systems (currently,
only X11 with new enough Xcomposite and Xdamage extensions).
You must call gdk_display_supports_composite() to check if
setting a window as composited is supported before
attempting to do so.

Since: 2.12

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="composited">
<parameter_description> %TRUE to set the window as composited
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_cursor">
<description>
Sets the default mouse pointer for a #GdkWindow. Use gdk_cursor_new_for_display()
or gdk_cursor_new_from_pixbuf() to create the cursor. To make the cursor
invisible, use %GDK_BLANK_CURSOR. Passing %NULL for the @cursor argument
to gdk_window_set_cursor() means that @window will use the cursor of its
parent window. Most windows should use this default.

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="cursor">
<parameter_description> a cursor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_debug_updates">
<description>
With update debugging enabled, calls to
gdk_window_invalidate_region() clear the invalidated region of the
screen to a noticeable color, and GDK pauses for a short time
before sending exposes to windows during
gdk_window_process_updates().  The net effect is that you can see
the invalid region for each window and watch redraws as they
occur. This allows you to diagnose inefficiencies in your application.

In essence, because the GDK rendering model prevents all flicker,
if you are redrawing the same region 400 times you may never
notice, aside from noticing a speed problem. Enabling update
debugging causes GTK to flicker slowly and noticeably, so you can
see exactly what's being redrawn when, in what order.

The --gtk-debug=updates command line option passed to GTK+ programs
enables this debug option at application startup time. That's
usually more useful than calling gdk_window_set_debug_updates()
yourself, though you might want to use this function to enable
updates sometime after application startup time.


</description>
<parameters>
<parameter name="setting">
<parameter_description> %TRUE to turn on update debugging
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_decorations">
<description>
&quot;Decorations&quot; are the features the window manager adds to a toplevel #GdkWindow.
This function sets the traditional Motif window manager hints that tell the
window manager which decorations you would like your window to have.
Usually you should use gtk_window_set_decorated() on a #GtkWindow instead of
using the GDK function directly.

The @decorations argument is the logical OR of the fields in
the #GdkWMDecoration enumeration. If #GDK_DECOR_ALL is included in the
mask, the other bits indicate which decorations should be turned off.
If #GDK_DECOR_ALL is not included, then the other bits indicate
which decorations should be turned on.

Most window managers honor a decorations hint of 0 to disable all decorations,
but very few honor all possible combinations of bits.


</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="decorations">
<parameter_description> decoration hint mask
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_device_cursor">
<description>
Sets a specific #GdkCursor for a given device when it gets inside @window.
Use gdk_cursor_new_for_display() or gdk_cursor_new_from_pixbuf() to create
the cursor. To make the cursor invisible, use %GDK_BLANK_CURSOR. Passing
%NULL for the @cursor argument to gdk_window_set_cursor() means that
@window will use the cursor of its parent window. Most windows should
use this default.

Since: 3.0

</description>
<parameters>
<parameter name="window">
<parameter_description> a #Gdkwindow
</parameter_description>
</parameter>
<parameter name="device">
<parameter_description> a master, pointer #GdkDevice
</parameter_description>
</parameter>
<parameter name="cursor">
<parameter_description> a #GdkCursor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_device_events">
<description>
Sets the event mask for a given device (Normally a floating device, not
attached to any visible pointer) to @window. For example, an event mask
including #GDK_BUTTON_PRESS_MASK means the window should report button
press events. The event mask is the bitwise OR of values from the
#GdkEventMask enumeration.

Since: 3.0

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="device">
<parameter_description> #GdkDevice to enable events for.
</parameter_description>
</parameter>
<parameter name="event_mask">
<parameter_description> event mask for @window
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_events">
<description>
The event mask for a window determines which events will be reported
for that window from all master input devices. For example, an event mask
including #GDK_BUTTON_PRESS_MASK means the window should report button
press events. The event mask is the bitwise OR of values from the
#GdkEventMask enumeration.

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="event_mask">
<parameter_description> event mask for @window
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_focus_on_map">
<description>
Setting @focus_on_map to %FALSE hints the desktop environment that the
window doesn't want to receive input focus when it is mapped.
focus_on_map should be turned off for windows that aren't triggered
interactively (such as popups from network activity).

On X, it is the responsibility of the window manager to interpret
this hint. Window managers following the freedesktop.org window
manager extension specification should respect it.

Since: 2.6

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="focus_on_map">
<parameter_description> %TRUE if the window should receive input focus when mapped
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_fullscreen_mode">
<description>
Specifies whether the @window should span over all monitors (in a multi-head
setup) or only the current monitor when in fullscreen mode.

The @mode argument is from the #GdkFullscreenMode enumeration.
If #GDK_FULLSCREEN_ON_ALL_MONITORS is specified, the fullscreen @window will
span over all monitors from the #GdkScreen.

On X11, searches through the list of monitors from the #GdkScreen the ones
which delimit the 4 edges of the entire #GdkScreen and will ask the window
manager to span the @window over these monitors.

If the XINERAMA extension is not available or not usable, this function
has no effect.

Not all window managers support this, so you can't rely on the fullscreen
window to span over the multiple monitors when #GDK_FULLSCREEN_ON_ALL_MONITORS
is specified.

Since: 3.8

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="mode">
<parameter_description> fullscreen mode
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_functions">
<description>
Sets hints about the window management functions to make available
via buttons on the window frame.

On the X backend, this function sets the traditional Motif window
manager hint for this purpose. However, few window managers do
anything reliable or interesting with this hint. Many ignore it
entirely.

The @functions argument is the logical OR of values from the
#GdkWMFunction enumeration. If the bitmask includes #GDK_FUNC_ALL,
then the other bits indicate which functions to disable; if
it doesn't include #GDK_FUNC_ALL, it indicates which functions to
enable.


</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="functions">
<parameter_description> bitmask of operations to allow on @window
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_geometry_hints">
<description>
Sets the geometry hints for @window. Hints flagged in @geom_mask
are set, hints not flagged in @geom_mask are unset.
To unset all hints, use a @geom_mask of 0 and a @geometry of %NULL.

This function provides hints to the windowing system about
acceptable sizes for a toplevel window. The purpose of
this is to constrain user resizing, but the windowing system
will typically  (but is not required to) also constrain the
current size of the window to the provided values and
constrain programatic resizing via gdk_window_resize() or
gdk_window_move_resize().

Note that on X11, this effect has no effect on windows
of type %GDK_WINDOW_TEMP or windows where override redirect
has been turned on via gdk_window_set_override_redirect()
since these windows are not resizable by the user.

Since you can't count on the windowing system doing the
constraints for programmatic resizes, you should generally
call gdk_window_constrain_size() yourself to determine
appropriate sizes.


</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="geometry">
<parameter_description> geometry hints
</parameter_description>
</parameter>
<parameter name="geom_mask">
<parameter_description> bitmask indicating fields of @geometry to pay attention to
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_group">
<description>
Sets the group leader window for @window. By default,
GDK sets the group leader for all toplevel windows
to a global window implicitly created by GDK. With this function
you can override this default.

The group leader window allows the window manager to distinguish
all windows that belong to a single application. It may for example
allow users to minimize/unminimize all windows belonging to an
application at once. You should only set a non-default group window
if your application pretends to be multiple applications.

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="leader">
<parameter_description> group leader window, or %NULL to restore the default group leader window
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_icon_list">
<description>
Sets a list of icons for the window. One of these will be used
to represent the window when it has been iconified. The icon is
usually shown in an icon box or some sort of task bar. Which icon
size is shown depends on the window manager. The window manager
can scale the icon  but setting several size icons can give better
image quality since the window manager may only need to scale the
icon by a small amount or not at all.


</description>
<parameters>
<parameter name="window">
<parameter_description> The #GdkWindow toplevel window to set the icon of.
</parameter_description>
</parameter>
<parameter name="pixbufs">
<parameter_description>
A list of pixbufs, of different sizes.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_icon_name">
<description>
Windows may have a name used while minimized, distinct from the
name they display in their titlebar. Most of the time this is a bad
idea from a user interface standpoint. But you can set such a name
with this function, if you like.

After calling this with a non-%NULL @name, calls to gdk_window_set_title()
will not update the icon title.

Using %NULL for @name unsets the icon title; further calls to
gdk_window_set_title() will again update the icon title as well.

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="name">
<parameter_description> name of window while iconified (minimized)
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_keep_above">
<description>
Set if @window must be kept above other windows. If the
window was already above, then this function does nothing.

On X11, asks the window manager to keep @window above, if the window
manager supports this operation. Not all window managers support
this, and some deliberately ignore it or don't have a concept of
&quot;keep above&quot;; so you can't rely on the window being kept above.
But it will happen with most standard window managers,
and GDK makes a best effort to get it to happen.

Since: 2.4

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="setting">
<parameter_description> whether to keep @window above other windows
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_keep_below">
<description>
Set if @window must be kept below other windows. If the
window was already below, then this function does nothing.

On X11, asks the window manager to keep @window below, if the window
manager supports this operation. Not all window managers support
this, and some deliberately ignore it or don't have a concept of
&quot;keep below&quot;; so you can't rely on the window being kept below.
But it will happen with most standard window managers,
and GDK makes a best effort to get it to happen.

Since: 2.4

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="setting">
<parameter_description> whether to keep @window below other windows
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_modal_hint">
<description>
The application can use this hint to tell the window manager
that a certain window has modal behaviour. The window manager
can use this information to handle modal windows in a special
way.

You should only use this on windows for which you have
previously called gdk_window_set_transient_for()

</description>
<parameters>
<parameter name="window">
<parameter_description> A toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="modal">
<parameter_description> %TRUE if the window is modal, %FALSE otherwise.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_opacity">
<description>
Set @window to render as partially transparent,
with opacity 0 being fully transparent and 1 fully opaque. (Values
of the opacity parameter are clamped to the [0,1] range.) 

For toplevel windows this depends on support from the windowing system
that may not always be there. For instance, On X11, this works only on
X screens with a compositing manager running.

For child windows this function only works for non-native windows.

For setting up per-pixel alpha topelevels, see gdk_screen_get_rgba_visual(),
and for non-toplevels, see gdk_window_set_composited().

Support for non-toplevel windows was added in 3.8.

Since: 2.12

</description>
<parameters>
<parameter name="window">
<parameter_description> a top-level or non-native #GdkWindow
</parameter_description>
</parameter>
<parameter name="opacity">
<parameter_description> opacity
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_override_redirect">
<description>
An override redirect window is not under the control of the window manager.
This means it won't have a titlebar, won't be minimizable, etc. - it will
be entirely under the control of the application. The window manager
can't see the override redirect window at all.

Override redirect should only be used for short-lived temporary
windows, such as popup menus. #GtkMenu uses an override redirect
window in its implementation, for example.


</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="override_redirect">
<parameter_description> %TRUE if window should be override redirect
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_role">
<description>
When using GTK+, typically you should use gtk_window_set_role() instead
of this low-level function.

The window manager and session manager use a window's role to
distinguish it from other kinds of window in the same application.
When an application is restarted after being saved in a previous
session, all windows with the same title and role are treated as
interchangeable.  So if you have two windows with the same title
that should be distinguished for session management purposes, you
should set the role on those windows. It doesn't matter what string
you use for the role, as long as you have a different role for each
non-interchangeable kind of window.


</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="role">
<parameter_description> a string indicating its role
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_skip_pager_hint">
<description>
Toggles whether a window should appear in a pager (workspace
switcher, or other desktop utility program that displays a small
thumbnail representation of the windows on the desktop). If a
window's semantic type as specified with gdk_window_set_type_hint()
already fully describes the window, this function should
&lt;emphasis&gt;not&lt;/emphasis&gt; be called in addition, instead you should
allow the window to be treated according to standard policy for
its semantic type.

Since: 2.2

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="skips_pager">
<parameter_description> %TRUE to skip the pager
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_skip_taskbar_hint">
<description>
Toggles whether a window should appear in a task list or window
list. If a window's semantic type as specified with
gdk_window_set_type_hint() already fully describes the window, this
function should &lt;emphasis&gt;not&lt;/emphasis&gt; be called in addition,
instead you should allow the window to be treated according to
standard policy for its semantic type.

Since: 2.2

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="skips_taskbar">
<parameter_description> %TRUE to skip the taskbar
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_source_events">
<description>
Sets the event mask for any floating device (i.e. not attached to any
visible pointer) that has the source defined as @source. This event
mask will be applied both to currently existing, newly added devices
after this call, and devices being attached/detached.

Since: 3.0

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="source">
<parameter_description> a #GdkInputSource to define the source class.
</parameter_description>
</parameter>
<parameter name="event_mask">
<parameter_description> event mask for @window
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_startup_id">
<description>
When using GTK+, typically you should use gtk_window_set_startup_id()
instead of this low-level function.

Since: 2.12


</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="startup_id">
<parameter_description> a string with startup-notification identifier
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_static_gravities">
<description>
Set the bit gravity of the given window to static, and flag it so
all children get static subwindow gravity. This is used if you are
implementing scary features that involve deep knowledge of the
windowing system. Don't worry about it unless you have to.


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="use_static">
<parameter_description> %TRUE to turn on static gravity
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the server supports static gravity
</return>
</function>

<function name="gdk_window_set_support_multidevice">
<description>
This function will enable multidevice features in @window.

Multidevice aware windows will need to handle properly multiple,
per device enter/leave events, device grabs and grab ownerships.

Since: 3.0

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow.
</parameter_description>
</parameter>
<parameter name="support_multidevice">
<parameter_description> %TRUE to enable multidevice support in @window.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_title">
<description>
Sets the title of a toplevel window, to be displayed in the titlebar.
If you haven't explicitly set the icon name for the window
(using gdk_window_set_icon_name()), the icon name will be set to
@title as well. @title must be in UTF-8 encoding (as with all
user-readable strings in GDK/GTK+). @title may not be %NULL.

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="title">
<parameter_description> title of @window
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_transient_for">
<description>
Indicates to the window manager that @window is a transient dialog
associated with the application window @parent. This allows the
window manager to do things like center @window on @parent and
keep @window above @parent.

See gtk_window_set_transient_for() if you're using #GtkWindow or
#GtkDialog.

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="parent">
<parameter_description> another toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_type_hint">
<description>
The application can use this call to provide a hint to the window
manager about the functionality of a window. The window manager
can use this information when determining the decoration and behaviour
of the window.

The hint must be set before the window is mapped.

</description>
<parameters>
<parameter name="window">
<parameter_description> A toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="hint">
<parameter_description> A hint of the function this window will have
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_urgency_hint">
<description>
Toggles whether a window needs the user's
urgent attention.

Since: 2.8

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="urgent">
<parameter_description> %TRUE if the window is urgent
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_set_user_data">
<description>
For most purposes this function is deprecated in favor of
g_object_set_data(). However, for historical reasons GTK+ stores
the #GtkWidget that owns a #GdkWindow as user data on the
#GdkWindow. So, custom widget implementations should use
this function for that. If GTK+ receives an event for a #GdkWindow,
and the user data for the window is non-%NULL, GTK+ will assume the
user data is a #GtkWidget, and forward the event to that widget.


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="user_data">
<parameter_description> user data
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_shape_combine_region">
<description>
Makes pixels in @window outside @shape_region be transparent,
so that the window may be nonrectangular.

If @shape_region is %NULL, the shape will be unset, so the whole
window will be opaque again. @offset_x and @offset_y are ignored
if @shape_region is %NULL.

On the X11 platform, this uses an X server extension which is
widely available on most common platforms, but not available on
very old X servers, and occasionally the implementation will be
buggy. On servers without the shape extension, this function
will do nothing.

This function works on both toplevel and child windows.

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="shape_region">
<parameter_description> region of window to be non-transparent
</parameter_description>
</parameter>
<parameter name="offset_x">
<parameter_description> X position of @shape_region in @window coordinates
</parameter_description>
</parameter>
<parameter name="offset_y">
<parameter_description> Y position of @shape_region in @window coordinates
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_show">
<description>
Like gdk_window_show_unraised(), but also raises the window to the
top of the window stack (moves the window to the front of the
Z-order).

This function maps a window so it's visible onscreen. Its opposite
is gdk_window_hide().

When implementing a #GtkWidget, you should call this function on the widget's
#GdkWindow as part of the &quot;map&quot; method.

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_show_unraised">
<description>
Shows a #GdkWindow onscreen, but does not modify its stacking
order. In contrast, gdk_window_show() will raise the window
to the top of the window stack.

On the X11 platform, in Xlib terms, this function calls
XMapWindow() (it also updates some internal GDK state, which means
that you can't really use XMapWindow() directly on a GDK window).

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_stick">
<description>
&quot;Pins&quot; a window such that it's on all workspaces and does not scroll
with viewports, for window managers that have scrollable viewports.
(When using #GtkWindow, gtk_window_stick() may be more useful.)

On the X11 platform, this function depends on window manager
support, so may have no effect with many window managers. However,
GDK will do the best it can to convince the window manager to stick
the window. For window managers that don't support this operation,
there's nothing you can do to force it to happen.


</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_thaw_toplevel_updates_libgtk_only">
<description>
Thaws a window frozen with
gdk_window_freeze_toplevel_updates_libgtk_only().

This function is not part of the GDK public API and is only
for use by GTK+.

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_thaw_updates">
<description>
Thaws a window frozen with gdk_window_freeze_updates().

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_unfullscreen">
<description>
Moves the window out of fullscreen mode. If the window was not
fullscreen, does nothing.

On X11, asks the window manager to move @window out of the fullscreen
state, if the window manager supports this operation. Not all
window managers support this, and some deliberately ignore it or
don't have a concept of &quot;fullscreen&quot;; so you can't rely on the
unfullscreenification actually happening. But it will happen with
most standard window managers, and GDK makes a best effort to get
it to happen.

Since: 2.2

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_unmaximize">
<description>
Unmaximizes the window. If the window wasn't maximized, then this
function does nothing.

On X11, asks the window manager to unmaximize @window, if the
window manager supports this operation. Not all window managers
support this, and some deliberately ignore it or don't have a
concept of &quot;maximized&quot;; so you can't rely on the unmaximization
actually happening. But it will happen with most standard window
managers, and GDK makes a best effort to get it to happen.

On Windows, reliably unmaximizes the window.


</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_unstick">
<description>
Reverse operation for gdk_window_stick(); see gdk_window_stick(),
and gtk_window_unstick().


</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_window_withdraw">
<description>
Withdraws a window (unmaps it and asks the window manager to forget about it).
This function is not really useful as gdk_window_hide() automatically
withdraws toplevel windows before hiding them.

</description>
<parameters>
<parameter name="window">
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_x11_atom_to_xatom">
<description>
Converts from a #GdkAtom to the X atom for the default GDK display
with the same string value.


</description>
<parameters>
<parameter name="atom">
<parameter_description> A #GdkAtom 
</parameter_description>
</parameter>
</parameters>
<return> the X atom corresponding to @atom.
</return>
</function>

<function name="gdk_x11_atom_to_xatom_for_display">
<description>
Converts from a #GdkAtom to the X atom for a #GdkDisplay
with the same string value. The special value %GDK_NONE
is converted to %None.

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description> A #GdkDisplay
</parameter_description>
</parameter>
<parameter name="atom">
<parameter_description> A #GdkAtom, or %GDK_NONE
</parameter_description>
</parameter>
</parameters>
<return> the X atom corresponding to @atom, or %None

</return>
</function>

<function name="gdk_x11_cursor_get_xcursor">
<description>
Returns the X cursor belonging to a #GdkCursor.


</description>
<parameters>
<parameter name="cursor">
<parameter_description> a #GdkCursor.
</parameter_description>
</parameter>
</parameters>
<return> an Xlib &lt;type&gt;Cursor&lt;/type&gt;.
</return>
</function>

<function name="gdk_x11_cursor_get_xdisplay">
<description>
Returns the display of a #GdkCursor.


</description>
<parameters>
<parameter name="cursor">
<parameter_description> a #GdkCursor.
</parameter_description>
</parameter>
</parameters>
<return> an Xlib &lt;type&gt;Display*&lt;/type&gt;.
</return>
</function>

<function name="gdk_x11_device_get_id">
<description>
Returns the device ID as seen by XInput2.

&lt;note&gt;
If gdk_disable_multidevice() has been called, this function
will respectively return 2/3 for the core pointer and keyboard,
(matching the IDs for the Virtual Core Pointer and Keyboard in
XInput 2), but calling this function on any slave devices (i.e.
those managed via XInput 1.x), will return 0.
&lt;/note&gt;

Since: 3.2

</description>
<parameters>
<parameter name="device">
<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
<return> the XInput2 device ID.

</return>
</function>

<function name="gdk_x11_device_manager_lookup">
<description>
Returns the #GdkDevice that wraps the given device ID.

Since: 3.2

</description>
<parameters>
<parameter name="device_manager">
<parameter_description> a #GdkDeviceManager
</parameter_description>
</parameter>
<parameter name="device_id">
<parameter_description> a device ID, as understood by the XInput2 protocol
</parameter_description>
</parameter>
</parameters>
<return> The #GdkDevice wrapping the device ID,
or %NULL if the given ID doesn't currently represent a device.

</return>
</function>

<function name="gdk_x11_display_broadcast_startup_message">
<description>
Sends a startup notification message of type @message_type to
@display. 

This is a convenience function for use by code that implements the
freedesktop startup notification specification. Applications should
not normally need to call it directly. See the &lt;ulink
url=&quot;http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt&quot;&gt;Startup
Notification Protocol specification&lt;/ulink&gt; for
definitions of the message types and keys that can be used.

Since: 2.12

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
<parameter name="message_type">
<parameter_description> startup notification message type (&quot;new&quot;, &quot;change&quot;,
or &quot;remove&quot;)
</parameter_description>
</parameter>
<parameter name="Varargs">
<parameter_description> a list of key/value pairs (as strings), terminated by a
%NULL key. (A %NULL value for a key will cause that key to be
skipped in the output.)
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_x11_display_error_trap_pop">
<description>
Pops the error trap pushed by gdk_x11_display_error_trap_push().
Will XSync() if necessary and will always block until
the error is known to have occurred or not occurred,
so the error code can be returned.

If you don't need to use the return value,
gdk_x11_display_error_trap_pop_ignored() would be more efficient.

See gdk_error_trap_pop() for the all-displays-at-once
equivalent.

Since: 3.0


</description>
<parameters>
<parameter name="display">
<parameter_description> the display
</parameter_description>
</parameter>
</parameters>
<return> X error code or 0 on success
</return>
</function>

<function name="gdk_x11_display_error_trap_pop_ignored">
<description>
Pops the error trap pushed by gdk_x11_display_error_trap_push().
Does not block to see if an error occurred; merely records the
range of requests to ignore errors for, and ignores those errors
if they arrive asynchronously.

See gdk_error_trap_pop_ignored() for the all-displays-at-once
equivalent.

Since: 3.0

</description>
<parameters>
<parameter name="display">
<parameter_description> the display
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_x11_display_error_trap_push">
<description>
Begins a range of X requests on @display for which X error events
will be ignored. Unignored errors (when no trap is pushed) will abort
the application. Use gdk_x11_display_error_trap_pop() or
gdk_x11_display_error_trap_pop_ignored()to lift a trap pushed
with this function.

See also gdk_error_trap_push() to push a trap on all displays.

Since: 3.0

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_x11_display_get_startup_notification_id">
<description>
Gets the startup notification ID for a display.

Since: 2.12

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return> the startup notification ID for @display

</return>
</function>

<function name="gdk_x11_display_get_user_time">
<description>
Returns the timestamp of the last user interaction on 
@display. The timestamp is taken from events caused
by user interaction such as key presses or pointer 
movements. See gdk_x11_window_set_user_time().

Since: 2.8

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return> the timestamp of the last user interaction 

</return>
</function>

<function name="gdk_x11_display_get_xdisplay">
<description>
Returns the X display of a #GdkDisplay.

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return> an X display

</return>
</function>

<function name="gdk_x11_display_grab">
<description>
Call XGrabServer() on @display. 
To ungrab the display again, use gdk_x11_display_ungrab(). 

gdk_x11_display_grab()/gdk_x11_display_ungrab() calls can be nested.

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay 
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_x11_display_set_cursor_theme">
<description>
Sets the cursor theme from which the images for cursor
should be taken.

If the windowing system supports it, existing cursors created
with gdk_cursor_new(), gdk_cursor_new_for_display() and
gdk_cursor_new_for_name() are updated to reflect the theme
change. Custom cursors constructed with
gdk_cursor_new_from_pixbuf() will have to be handled
by the application (GTK+ applications can learn about
cursor theme changes by listening for change notification
for the corresponding #GtkSetting).

Since: 2.8

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
<parameter name="theme">
<parameter_description> the name of the cursor theme to use, or %NULL to unset
a previously set value
</parameter_description>
</parameter>
<parameter name="size">
<parameter_description> the cursor size to use, or 0 to keep the previous size
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_x11_display_set_startup_notification_id">
<description>
Sets the startup notification ID for a display.

This is usually taken from the value of the DESKTOP_STARTUP_ID
environment variable, but in some cases (such as the application not
being launched using exec()) it can come from other sources.

If the ID contains the string &quot;_TIME&quot; then the portion following that
string is taken to be the X11 timestamp of the event that triggered
the application to be launched and the GDK current event time is set
accordingly.

The startup ID is also what is used to signal that the startup is
complete (for example, when opening a window or when calling
gdk_notify_startup_complete()).

Since: 3.0

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
<parameter name="startup_id">
<parameter_description> the startup notification ID (must be valid utf8)
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_x11_display_string_to_compound_text">
<description>
Convert a string from the encoding of the current
locale into a form suitable for storing in a window property.

Since: 2.24

</description>
<parameters>
<parameter name="display">
<parameter_description> the #GdkDisplay where the encoding is defined
</parameter_description>
</parameter>
<parameter name="str">
<parameter_description> a nul-terminated string
</parameter_description>
</parameter>
<parameter name="encoding">
<parameter_description> location to store the encoding atom
(to be used as the type for the property)
</parameter_description>
</parameter>
<parameter name="format">
<parameter_description> location to store the format of the property
</parameter_description>
</parameter>
<parameter name="ctext">
<parameter_description> location to store newly
allocated data for the property
</parameter_description>
</parameter>
<parameter name="length">
<parameter_description> the length of @ctext, in bytes
</parameter_description>
</parameter>
</parameters>
<return> 0 upon success, non-zero upon failure

</return>
</function>

<function name="gdk_x11_display_text_property_to_text_list">
<description>
Convert a text string from the encoding as it is stored
in a property into an array of strings in the encoding of
the current locale. (The elements of the array represent the
nul-separated elements of the original text string.)

Since: 2.24

</description>
<parameters>
<parameter name="display">
<parameter_description> The #GdkDisplay where the encoding is defined
</parameter_description>
</parameter>
<parameter name="encoding">
<parameter_description> an atom representing the encoding. The most
common values for this are STRING, or COMPOUND_TEXT.
This is value used as the type for the property
</parameter_description>
</parameter>
<parameter name="format">
<parameter_description> the format of the property
</parameter_description>
</parameter>
<parameter name="text">
<parameter_description> The text data
</parameter_description>
</parameter>
<parameter name="length">
<parameter_description> The number of items to transform
</parameter_description>
</parameter>
<parameter name="list">
<parameter_description> location to store an  array of strings in
the encoding of the current locale. This array should be
freed using gdk_free_text_list().
</parameter_description>
</parameter>
</parameters>
<return> the number of strings stored in list, or 0,
if the conversion failed

</return>
</function>

<function name="gdk_x11_display_ungrab">
<description>
Ungrab @display after it has been grabbed with 
gdk_x11_display_grab(). 

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_x11_display_utf8_to_compound_text">
<description>
Converts from UTF-8 to compound text.

Since: 2.24

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
<parameter name="str">
<parameter_description> a UTF-8 string
</parameter_description>
</parameter>
<parameter name="encoding">
<parameter_description> location to store resulting encoding
</parameter_description>
</parameter>
<parameter name="format">
<parameter_description> location to store format of the result
</parameter_description>
</parameter>
<parameter name="ctext">
<parameter_description> location to store the data of the result
</parameter_description>
</parameter>
<parameter name="length">
<parameter_description> location to store the length of the data
stored in @ctext
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the conversion succeeded,
otherwise %FALSE

</return>
</function>

<function name="gdk_x11_free_compound_text">
<description>
Frees the data returned from gdk_x11_display_string_to_compound_text().

Since: 2.24

</description>
<parameters>
<parameter name="ctext">
<parameter_description> The pointer stored in @ctext from a call to
gdk_x11_display_string_to_compound_text().
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_x11_free_text_list">
<description>
Frees the array of strings created by
gdk_x11_display_text_property_to_text_list().

Since: 2.24

</description>
<parameters>
<parameter name="list">
<parameter_description> the value stored in the @list parameter by
a call to gdk_x11_display_text_property_to_text_list().
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_x11_get_default_root_xwindow">
<description>
Gets the root window of the default screen 
(see gdk_x11_get_default_screen()).  


</description>
<parameters>
</parameters>
<return> an Xlib &lt;type&gt;Window&lt;/type&gt;.
</return>
</function>

<function name="gdk_x11_get_default_screen">
<description>
Gets the default GTK+ screen number.


</description>
<parameters>
</parameters>
<return> returns the screen number specified by
the --display command line option or the DISPLAY environment
variable when gdk_init() calls XOpenDisplay().
</return>
</function>

<function name="gdk_x11_get_default_xdisplay">
<description>
Gets the default GTK+ display.


</description>
<parameters>
</parameters>
<return> the Xlib &lt;type&gt;Display*&lt;/type&gt; for
the display specified in the &lt;option&gt;--display&lt;/option&gt; command
line option or the &lt;envar&gt;DISPLAY&lt;/envar&gt; environment variable.
</return>
</function>

<function name="gdk_x11_get_server_time">
<description>
Routine to get the current X server time stamp.


</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow, used for communication
with the server.  The window must have
GDK_PROPERTY_CHANGE_MASK in its events mask or a hang will
result.
</parameter_description>
</parameter>
</parameters>
<return> the time stamp.
</return>
</function>

<function name="gdk_x11_get_xatom_by_name">
<description>
Returns the X atom for GDK's default display corresponding to @atom_name.
This function caches the result, so if called repeatedly it is much
faster than XInternAtom(), which is a round trip to the server each time.


</description>
<parameters>
<parameter name="atom_name">
<parameter_description> a string
</parameter_description>
</parameter>
</parameters>
<return> a X atom for GDK's default display.
</return>
</function>

<function name="gdk_x11_get_xatom_by_name_for_display">
<description>
Returns the X atom for a #GdkDisplay corresponding to @atom_name.
This function caches the result, so if called repeatedly it is much
faster than XInternAtom(), which is a round trip to the server each time.

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
<parameter name="atom_name">
<parameter_description> a string
</parameter_description>
</parameter>
</parameters>
<return> a X atom for a #GdkDisplay

</return>
</function>

<function name="gdk_x11_get_xatom_name">
<description>
Returns the name of an X atom for GDK's default display. This
function is meant mainly for debugging, so for convenience, unlike
&lt;function&gt;XAtomName()&lt;/function&gt; and gdk_atom_name(), the result 
doesn't need to be freed. Also, this function will never return %NULL, 
even if @xatom is invalid.


</description>
<parameters>
<parameter name="xatom">
<parameter_description> an X atom for GDK's default display
</parameter_description>
</parameter>
</parameters>
<return> name of the X atom; this string is owned by GTK+,
so it shouldn't be modifed or freed. 
</return>
</function>

<function name="gdk_x11_get_xatom_name_for_display">
<description>
Returns the name of an X atom for its display. This
function is meant mainly for debugging, so for convenience, unlike
XAtomName() and gdk_atom_name(), the result doesn't need to
be freed. 

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description> the #GdkDisplay where @xatom is defined
</parameter_description>
</parameter>
<parameter name="xatom">
<parameter_description> an X atom 
</parameter_description>
</parameter>
</parameters>
<return> name of the X atom; this string is owned by GDK,
so it shouldn't be modifed or freed. 

</return>
</function>

<function name="gdk_x11_grab_server">
<description>
Call gdk_x11_display_grab() on the default display. 
To ungrab the server again, use gdk_x11_ungrab_server(). 

gdk_x11_grab_server()/gdk_x11_ungrab_server() calls can be nested.

</description>
<parameters>
</parameters>
<return></return>
</function>

<function name="gdk_x11_keymap_get_group_for_state">
<description>
Extracts the group from the state field sent in an X Key event.
This is only needed for code processing raw X events, since #GdkEventKey
directly includes an is_modifier field.

Since: 3.6

</description>
<parameters>
<parameter name="keymap">
<parameter_description> a #GdkX11Keymap
</parameter_description>
</parameter>
<parameter name="state">
<parameter_description> raw state returned from X
</parameter_description>
</parameter>
</parameters>
<return> the index of the active keyboard group for the event

</return>
</function>

<function name="gdk_x11_keymap_key_is_modifier">
<description>
Determines whether a particular key code represents a key that
is a modifier. That is, it's a key that normally just affects
the keyboard state and the behavior of other keys rather than
producing a direct effect itself. This is only needed for code
processing raw X events, since #GdkEventKey directly includes
an is_modifier field.

Since: 3.6

</description>
<parameters>
<parameter name="keymap">
<parameter_description> a #GdkX11Keymap
</parameter_description>
</parameter>
<parameter name="keycode">
<parameter_description> the hardware keycode from a key event
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the hardware keycode is a modifier key

</return>
</function>

<function name="gdk_x11_lookup_xdisplay">
<description>
Find the #GdkDisplay corresponding to @display, if any exists.

Since: 2.2

</description>
<parameters>
<parameter name="xdisplay">
<parameter_description> a pointer to an X Display
</parameter_description>
</parameter>
</parameters>
<return> the #GdkDisplay, if found, otherwise %NULL.

</return>
</function>

<function name="gdk_x11_register_standard_event_type">
<description>
Registers interest in receiving extension events with type codes
between @event_base and &lt;literal&gt;event_base + n_events - 1&lt;/literal&gt;.
The registered events must have the window field in the same place
as core X events (this is not the case for e.g. XKB extension events).

If an event type is registered, events of this type will go through
global and window-specific filters (see gdk_window_add_filter()).
Unregistered events will only go through global filters.
GDK may register the events of some X extensions on its own.

This function should only be needed in unusual circumstances, e.g.
when filtering XInput extension events on the root window.

Since: 2.4

</description>
<parameters>
<parameter name="display">
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
<parameter name="event_base">
<parameter_description> first event type code to register
</parameter_description>
</parameter>
<parameter name="n_events">
<parameter_description> number of event type codes to register
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_x11_screen_get_monitor_output">
<description>
Gets the XID of the specified output/monitor.
If the X server does not support version 1.2 of the RANDR
extension, 0 is returned.

Since: 2.14

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
<parameter name="monitor_num">
<parameter_description> number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
</parameter_description>
</parameter>
</parameters>
<return> the XID of the monitor

</return>
</function>

<function name="gdk_x11_screen_get_screen_number">
<description>
Returns the index of a #GdkScreen.

Since: 2.2

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return> the position of @screen among the screens
of its display

</return>
</function>

<function name="gdk_x11_screen_get_window_manager_name">
<description>
Returns the name of the window manager for @screen.

Since: 2.2

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return> the name of the window manager screen @screen, or
&quot;unknown&quot; if the window manager is unknown. The string is owned by GDK
and should not be freed.

</return>
</function>

<function name="gdk_x11_screen_get_xscreen">
<description>
Returns the screen of a #GdkScreen.

Since: 2.2

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return> an Xlib &lt;type&gt;Screen*&lt;/type&gt;

</return>
</function>

<function name="gdk_x11_screen_lookup_visual">
<description>
Looks up the #GdkVisual for a particular screen and X Visual ID.

Since: 2.2

</description>
<parameters>
<parameter name="screen">
<parameter_description> a #GdkScreen.
</parameter_description>
</parameter>
<parameter name="xvisualid">
<parameter_description> an X Visual ID.
</parameter_description>
</parameter>
</parameters>
<return> the #GdkVisual (owned by the screen
object), or %NULL if the visual ID wasn't found.

</return>
</function>

<function name="gdk_x11_screen_supports_net_wm_hint">
<description>
This function is specific to the X11 backend of GDK, and indicates
whether the window manager supports a certain hint from the
Extended Window Manager Hints Specification. You can find this
specification on
&lt;ulink url=&quot;http://www.freedesktop.org&quot;&gt;http://www.freedesktop.org&lt;/ulink&gt;.

When using this function, keep in mind that the window manager
can change over time; so you shouldn't use this function in
a way that impacts persistent application state. A common bug
is that your application can start up before the window manager
does when the user logs in, and before the window manager starts
gdk_x11_screen_supports_net_wm_hint() will return %FALSE for every property.
You can monitor the window_manager_changed signal on #GdkScreen to detect
a window manager change.

Since: 2.2

</description>
<parameters>
<parameter name="screen">
<parameter_description> the relevant #GdkScreen.
</parameter_description>
</parameter>
<parameter name="property">
<parameter_description> a property atom.
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if the window manager supports @property

</return>
</function>

<function name="gdk_x11_set_sm_client_id">
<description>
Sets the &lt;literal&gt;SM_CLIENT_ID&lt;/literal&gt; property on the application's leader window so that
the window manager can save the application's state using the X11R6 ICCCM
session management protocol.

See the X Session Management Library documentation for more information on
session management and the Inter-Client Communication Conventions Manual

Since: 2.24

</description>
<parameters>
<parameter name="sm_client_id">
<parameter_description> the client id assigned by the session manager when the
connection was opened, or %NULL to remove the property.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_x11_ungrab_server">
<description>
Ungrab the default display after it has been grabbed with 
gdk_x11_grab_server(). 

</description>
<parameters>
</parameters>
<return></return>
</function>

<function name="gdk_x11_visual_get_xvisual">
<description>
Returns the X visual belonging to a #GdkVisual.


</description>
<parameters>
<parameter name="visual">
<parameter_description> a #GdkVisual.
</parameter_description>
</parameter>
</parameters>
<return> an Xlib &lt;type&gt;Visual*&lt;/type&gt;.
</return>
</function>

<function name="gdk_x11_window_foreign_new_for_display">
<description>
Wraps a native window in a #GdkWindow. The function will try to
look up the window using gdk_x11_window_lookup_for_display() first.
If it does not find it there, it will create a new window.

This may fail if the window has been destroyed. If the window
was already known to GDK, a new reference to the existing
#GdkWindow is returned.

Since: 2.24

</description>
<parameters>
<parameter name="display">
<parameter_description> the #GdkDisplay where the window handle comes from.
</parameter_description>
</parameter>
<parameter name="window">
<parameter_description> an XLib &lt;type&gt;Window&lt;/type&gt;
</parameter_description>
</parameter>
</parameters>
<return> a #GdkWindow wrapper for the native
window, or %NULL if the window has been destroyed. The wrapper
will be newly created, if one doesn't exist already.

</return>
</function>

<function name="gdk_x11_window_get_xid">
<description>
Returns the X resource (window) belonging to a #GdkWindow.


</description>
<parameters>
<parameter name="window">
<parameter_description> a native #GdkWindow.
</parameter_description>
</parameter>
</parameters>
<return> the ID of @drawable's X resource.
</return>
</function>

<function name="gdk_x11_window_lookup_for_display">
<description>
Looks up the #GdkWindow that wraps the given native window handle.

Since: 2.24

</description>
<parameters>
<parameter name="display">
<parameter_description> the #GdkDisplay corresponding to the
window handle
</parameter_description>
</parameter>
<parameter name="window">
<parameter_description> an XLib &lt;type&gt;Window&lt;/type&gt;
</parameter_description>
</parameter>
</parameters>
<return> the #GdkWindow wrapper for the native
window, or %NULL if there is none.

</return>
</function>

<function name="gdk_x11_window_move_to_current_desktop">
<description>
Moves the window to the correct workspace when running under a 
window manager that supports multiple workspaces, as described
in the &lt;ulink url=&quot;http://www.freedesktop.org/Standards/wm-spec&quot;&gt;Extended 
Window Manager Hints&lt;/ulink&gt;.  Will not do anything if the
window is already on all workspaces.

Since: 2.8

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_x11_window_set_hide_titlebar_when_maximized">
<description>
Set a hint for the window manager, requesting that the titlebar
should be hidden when the window is maximized.

Note that this property is automatically updated by GTK+, so this
function should only be used by applications which do not use GTK+
to create toplevel windows.

Since: 3.4

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="hide_titlebar_when_maximized">
<parameter_description> whether to hide the titlebar when
maximized
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_x11_window_set_theme_variant">
<description>
GTK+ applications can request a dark theme variant. In order to
make other applications - namely window managers using GTK+ for
themeing - aware of this choice, GTK+ uses this function to
export the requested theme variant as _GTK_THEME_VARIANT property
on toplevel windows.

Note that this property is automatically updated by GTK+, so this
function should only be used by applications which do not use GTK+
to create toplevel windows.

Since: 3.2

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="variant">
<parameter_description> the theme variant to export
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_x11_window_set_user_time">
<description>
The application can use this call to update the _NET_WM_USER_TIME
property on a toplevel window.  This property stores an Xserver
time which represents the time of the last user input event
received for this window.  This property may be used by the window
manager to alter the focus, stacking, and/or placement behavior of
windows when they are mapped depending on whether the new window
was created by a user action or is a &quot;pop-up&quot; window activated by a
timer or some other event.

Note that this property is automatically updated by GDK, so this
function should only be used by applications which handle input
events bypassing GDK.

Since: 2.6

</description>
<parameters>
<parameter name="window">
<parameter_description> A toplevel #GdkWindow
</parameter_description>
</parameter>
<parameter name="timestamp">
<parameter_description> An XServer timestamp to which the property should be set
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_x11_window_set_utf8_property">
<description>
This function modifies or removes an arbitrary X11 window
property of type UTF8_STRING.  If the given @window is
not a toplevel window, it is ignored.

Since: 3.4

</description>
<parameters>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="name">
<parameter_description> Property name, will be interned as an X atom
</parameter_description>
</parameter>
<parameter name="value">
<parameter_description> Property value, or %NULL to delete
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>

<function name="gdk_x11_xatom_to_atom">
<description>
Convert from an X atom for the default display to the corresponding
#GdkAtom.


</description>
<parameters>
<parameter name="xatom">
<parameter_description> an X atom for the default GDK display
</parameter_description>
</parameter>
</parameters>
<return> the corresponding G#dkAtom.
</return>
</function>

<function name="gdk_x11_xatom_to_atom_for_display">
<description>
Convert from an X atom for a #GdkDisplay to the corresponding
#GdkAtom.

Since: 2.2

</description>
<parameters>
<parameter name="display">
<parameter_description> A #GdkDisplay
</parameter_description>
</parameter>
<parameter name="xatom">
<parameter_description> an X atom 
</parameter_description>
</parameter>
</parameters>
<return> the corresponding #GdkAtom.

</return>
</function>

</root>
