[gtkmm] Regenerated methods .defs and documentation .xml files.
- From: Murray Cumming <murrayc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtkmm] Regenerated methods .defs and documentation .xml files.
- Date: Tue, 6 Sep 2011 09:23:39 +0000 (UTC)
commit 3a8fe801cf419411c30c94c5fd8fc398835fa60e
Author: Murray Cumming <murrayc murrayc com>
Date: Tue Sep 6 11:23:21 2011 +0200
Regenerated methods .defs and documentation .xml files.
* gdk/src/gdk_docs.xml: Regenerated with docextract_to_xml.py.
* gdk/src/gdk_extra_objects.defs: Mention some more objects to improve the
automatic documentation generation.
* gdk/src/gdk_methods.defs:
* gtk/src/gtk_methods.defs: Regenerated with h2defs.py.
* gdk/src/gdk_pixbuf_enums.defs: Regenerated with enums.pl.
We still need to regenerate the signals/properties .defs files.
ChangeLog | 12 +
gdk/src/gdk_docs.xml |16694 ++++++++++++++++++++--------------------
gdk/src/gdk_extra_objects.defs | 18 +
gdk/src/gdk_methods.defs | 139 +-
gdk/src/gdk_pixbuf_enums.defs | 112 +-
gtk/src/gtk_methods.defs | 94 +
6 files changed, 8624 insertions(+), 8445 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 723e3ae..5da2c40 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,17 @@
2011-09-06 Murray Cumming <murrayc murrayc com>
+ Regenerated methods .defs and documentation .xml files.
+
+ * gdk/src/gdk_docs.xml: Regenerated with docextract_to_xml.py.
+ * gdk/src/gdk_extra_objects.defs: Mention some more objects to improve the
+ automatic documentation generation.
+ * gdk/src/gdk_methods.defs:
+ * gtk/src/gtk_methods.defs: Regenerated with h2defs.py.
+ * gdk/src/gdk_pixbuf_enums.defs: Regenerated with enums.pl.
+ We still need to regenerate the signals/properties .defs files.
+
+2011-09-06 Murray Cumming <murrayc murrayc com>
+
Regenerated enum .defs files.
* gdk/src/gdk_enums.defs:
diff --git a/gdk/src/gdk_docs.xml b/gdk/src/gdk_docs.xml
index 68d6cec..a6941a6 100644
--- a/gdk/src/gdk_docs.xml
+++ b/gdk/src/gdk_docs.xml
@@ -1,338 +1,278 @@
<root>
-<function name="gdk_char_height">
+<function name="gdk_add_option_entries_libgtk_only">
<description>
-Determines the total height of a given character.
-This value is not generally useful, because you cannot
-determine how this total height will be drawn in
-relation to the baseline. See gdk_text_extents().
-
-Deprecated: 2.2: Use gdk_text_extents() instead.
+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="font">
-<parameter_description> a #GdkFont
-</parameter_description>
-</parameter>
-<parameter name="character">
-<parameter_description> the character to measure.
+<parameter name="group">
+<parameter_description> An option group.
</parameter_description>
</parameter>
</parameters>
-<return> the height of the character in pixels.
-
-</return>
+<return></return>
</function>
-<function name="gdk_add_client_message_filter">
+<function name="gdk_app_launch_context_new">
<description>
-Adds a filter to the default display to be called when X ClientMessage events
-are received. See gdk_display_add_client_message_filter().
+Creates a new #GdkAppLaunchContext.
+
+Since: 2.14
+
+Deprecated: 3.0: Use gdk_display_get_app_launch_context() instead
</description>
<parameters>
-<parameter name="message_type">
-<parameter_description> the type of ClientMessage events to receive. This will be
-checked against the <structfield>message_type</structfield> field of the
-XClientMessage event struct.
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> the function to call to process the event.
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> user data to pass to @func.
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> a new #GdkAppLaunchContext
+
+</return>
</function>
-<function name="gdk_display_get_screen">
+<function name="gdk_app_launch_context_set_desktop">
<description>
-Returns a screen object for one of the screens of the display.
+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
+<ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended
+Window Manager Hints</ulink>.
-Since: 2.2
+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="display">
-<parameter_description> a #GdkDisplay
+<parameter name="context">
+<parameter_description> a #GdkAppLaunchContext
</parameter_description>
</parameter>
-<parameter name="screen_num">
-<parameter_description> the screen number
+<parameter name="desktop">
+<parameter_description> the number of a workspace, or -1
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkScreen object
-
-</return>
+<return></return>
</function>
-<function name="gdk_x11_screen_get_xscreen">
+<function name="gdk_app_launch_context_set_display">
<description>
-Returns the screen of a #GdkScreen.
+Sets the display on which applications will be launched when
+using this context. See also gdk_app_launch_context_set_screen().
-Since: 2.2
+Since: 2.14
+
+Deprecated: 3.0: Use gdk_display_get_app_launch_context() instead
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen.
+<parameter name="context">
+<parameter_description> a #GdkAppLaunchContext
+</parameter_description>
+</parameter>
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return> an Xlib <type>Screen*</type>
-</return>
+<return></return>
</function>
-<function name="gdk_selection_send_notify_for_display">
+<function name="gdk_app_launch_context_set_icon">
<description>
-Send a response to SelectionRequest event.
+Sets the icon for applications that are launched with this
+context.
-Since: 2.2
+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="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 name="context">
+<parameter_description> a #GdkAppLaunchContext
</parameter_description>
</parameter>
-<parameter name="time_">
-<parameter_description> timestamp.
+<parameter name="icon">
+<parameter_description> a #GIcon, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_move_region">
+<function name="gdk_app_launch_context_set_icon_name">
<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.
+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().
-Child windows are not moved.
+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.8
+Since: 2.14
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="region">
-<parameter_description> The #GdkRegion to move
-</parameter_description>
-</parameter>
-<parameter name="dx">
-<parameter_description> Amount to move in the X direction
+<parameter name="context">
+<parameter_description> a #GdkAppLaunchContext
</parameter_description>
</parameter>
-<parameter name="dy">
-<parameter_description> Amount to move in the Y direction
+<parameter name="icon_name">
+<parameter_description> an icon name, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_screen_width">
+<function name="gdk_app_launch_context_set_screen">
<description>
-Returns the width of the default screen in pixels.
-
+Sets the screen on which applications will be launched when
+using this context. See also gdk_app_launch_context_set_display().
-</description>
-<parameters>
-</parameters>
-<return> the width of the default screen in pixels.
-</return>
-</function>
+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.
-<function name="gdk_gc_get_values">
-<description>
-Retrieves the current values from a graphics context. Note that
-only the pixel values of the @values->foreground and @values->background
-are filled, use gdk_colormap_query_color() to obtain the rgb values
-if you need them.
+Since: 2.14
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
+<parameter name="context">
+<parameter_description> a #GdkAppLaunchContext
</parameter_description>
</parameter>
-<parameter name="values">
-<parameter_description> the #GdkGCValues structure in which to store the results.
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_region_point_in">
+<function name="gdk_app_launch_context_set_timestamp">
<description>
-Finds out if a point is in a region.
+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="region">
-<parameter_description> a #GdkRegion
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x coordinate of a point
+<parameter name="context">
+<parameter_description> a #GdkAppLaunchContext
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the y coordinate of a point
+<parameter name="timestamp">
+<parameter_description> a timestamp
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the point is in @region.
-</return>
+<return></return>
</function>
-<function name="gdk_colors_free">
+<function name="gdk_atom_intern">
<description>
-Frees colors allocated with gdk_colors_alloc(). This
-function is obsolete. See gdk_colormap_free_colors().
+Finds or creates an atom corresponding to a given string.
+
</description>
<parameters>
-<parameter name="colormap">
-<parameter_description> a #GdkColormap.
-</parameter_description>
-</parameter>
-<parameter name="pixels">
-<parameter_description> the pixel values of the colors to free.
-</parameter_description>
-</parameter>
-<parameter name="npixels">
-<parameter_description> the number of values in @pixels.
+<parameter name="atom_name">
+<parameter_description> a string.
</parameter_description>
</parameter>
-<parameter name="planes">
-<parameter_description> the plane masks for all planes to free, OR'd together.
+<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></return>
+<return> the atom corresponding to @atom_name.
+</return>
</function>
-<function name="gdk_pixmap_create_from_xpm">
+<function name="gdk_atom_intern_static_string">
<description>
-Create a pixmap from a XPM file.
+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 <emphasis>always</emphasis> 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="drawable">
-<parameter_description> a #GdkDrawable, used to determine default values
-for the new pixmap.
-</parameter_description>
-</parameter>
-<parameter name="mask">
-<parameter_description> (out) a pointer to a place to store a bitmap representing
-the transparency mask of the XPM file. Can be %NULL,
-in which case transparency will be ignored.
-</parameter_description>
-</parameter>
-<parameter name="transparent_color">
-<parameter_description> the color to be used for the pixels
-that are transparent in the input file. Can be %NULL,
-in which case a default color will be used.
-</parameter_description>
-</parameter>
-<parameter name="filename">
-<parameter_description> the filename of a file containing XPM data.
+<parameter name="atom_name">
+<parameter_description> a static string
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkPixmap
+<return> the atom corresponding to @atom_name
+
</return>
</function>
-<function name="gdk_x11_cursor_get_xcursor">
+<function name="gdk_atom_name">
<description>
-Returns the X cursor belonging to a #GdkCursor.
+Determines the string corresponding to an atom.
</description>
<parameters>
-<parameter name="cursor">
-<parameter_description> a #GdkCursor.
+<parameter name="atom">
+<parameter_description> a #GdkAtom.
</parameter_description>
</parameter>
</parameters>
-<return> an Xlib <type>Cursor</type>.
+<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_drag_status">
+<function name="gdk_beep">
<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.
+Emits a short beep on the default display.
</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_window_shape_combine_mask">
+<function name="gdk_cairo_create">
<description>
-Applies a shape mask to @window. Pixels in @window corresponding to
-set bits in the @mask will be visible; pixels in @window
-corresponding to unset bits in the @mask will be transparent. This
-gives a non-rectangular window.
-
-If @mask is %NULL, the shape mask will be unset, and the @x/@y
-parameters are not used.
+Creates a Cairo context for drawing to @window.
-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.
+<note><warning>
+Note that calling cairo_reset_clip() on the resulting #cairo_t will
+produce undefined results, so avoid it at all costs.
+</warning></note>
-This function works on both toplevel and child windows.
+Since: 2.8
</description>
<parameters>
@@ -340,1533 +280,1415 @@ This function works on both toplevel and child windows.
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="mask">
-<parameter_description> shape mask
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> X position of shape mask with respect to @window
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> Y position of shape mask with respect to @window
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> A newly created Cairo context. Free with
+cairo_destroy() when you are done drawing.
+
+</return>
</function>
-<function name="gdk_color_copy">
+<function name="gdk_cairo_get_clip_rectangle">
<description>
-Makes a copy of a color structure. The result
-must be freed using gdk_color_free().
+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="color">
-<parameter_description> a #GdkColor.
+<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> a copy of @color.
+<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_event_get">
+<function name="gdk_cairo_rectangle">
<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().
+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> the next #GdkEvent to be processed, or %NULL if no events
-are pending. The returned #GdkEvent should be freed with gdk_event_free().
-</return>
+<return></return>
</function>
-<function name="gdk_gc_set_clip_rectangle">
+<function name="gdk_cairo_region">
<description>
-Sets the clip mask for a graphics context from a
-rectangle. The clip mask is interpreted relative to the clip
-origin. (See gdk_gc_set_clip_origin()).
+Adds the given region to the current path of @cr.
+
+Since: 2.8
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
+<parameter name="cr">
+<parameter_description> a cairo context
</parameter_description>
</parameter>
-<parameter name="rectangle">
-<parameter_description> the rectangle to clip to.
+<parameter name="region">
+<parameter_description> a #cairo_region_t
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_display_get_default_group">
+<function name="gdk_cairo_region_create_from_surface">
<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().
+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().
-Since: 2.4
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="surface">
+<parameter_description> a cairo surface
</parameter_description>
</parameter>
</parameters>
-<return> The default group leader window for @display
-
+<return> A #cairo_region_t; must be freed with cairo_region_destroy()
</return>
</function>
-<function name="gdk_gc_new_with_values">
+<function name="gdk_cairo_set_source_color">
<description>
-Create a new GC with the given initial values.
+Sets the specified #GdkColor as the source color of @cr.
+Since: 2.8
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable. The created GC must always be used
-with drawables of the same depth as this one.
-</parameter_description>
-</parameter>
-<parameter name="values">
-<parameter_description> a structure containing initial values for the GC.
+<parameter name="cr">
+<parameter_description> a cairo context
</parameter_description>
</parameter>
-<parameter name="values_mask">
-<parameter_description> a bit mask indicating which fields in @values
-are set.
+<parameter name="color">
+<parameter_description> a #GdkColor
</parameter_description>
</parameter>
</parameters>
-<return> the new graphics context.
-</return>
+<return></return>
</function>
-<function name="gdk_window_constrain_size">
+<function name="gdk_cairo_set_source_pixbuf">
<description>
-Constrains a desired width and height according to a
-set of geometry hints (such as minimum and maximum size).
+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="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 name="cr">
+<parameter_description> a cairo context
</parameter_description>
</parameter>
-<parameter name="new_width">
-<parameter_description> location to store resulting width
+<parameter name="pixbuf">
+<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
-<parameter name="new_height">
-<parameter_description> location to store resulting height
+<parameter name="pixbuf_x">
+<parameter_description> X coordinate of location to place upper left corner of @pixbuf
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gdk_drag_context_unref">
-<description>
-Deprecated function; use g_object_unref() instead.
-
-Deprecated: 2.2: Use g_object_unref() instead.
-
-</description>
-<parameters>
-<parameter name="context">
-<parameter_description> a #GdkDragContext.
+<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_pango_renderer_set_gc">
+<function name="gdk_cairo_set_source_rgba">
<description>
-Sets the GC the renderer draws with. Note that the GC must not be
-modified until it is unset by calling the function again with
-%NULL for the @gc parameter, since GDK may make internal copies
-of the GC which won't be updated to follow changes to the
-original GC.
+Sets the specified #GdkRGBA as the source color of @cr.
-Since: 2.6
+Since: 3.0
</description>
<parameters>
-<parameter name="gdk_renderer">
-<parameter_description> a #GdkPangoRenderer
+<parameter name="cr">
+<parameter_description> a cairo context
</parameter_description>
</parameter>
-<parameter name="gc">
-<parameter_description> the new GC to use for drawing, or %NULL
+<parameter name="rgba">
+<parameter_description> a #GdkRGBA
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_spawn_on_screen_with_pipes">
+<function name="gdk_cairo_set_source_window">
<description>
-Like g_spawn_async_with_pipes(), except the child process is
-spawned in such an environment that on calling gdk_display_open()
-it would be returned a #GdkDisplay with @screen as the default
-screen.
+Sets the given window as the source pattern for @cr.
-This is useful for applications which wish to launch an application
-on a specific screen.
+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.
-Since: 2.4
+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="screen">
-<parameter_description> a #GdkScreen
-</parameter_description>
-</parameter>
-<parameter name="working_directory">
-<parameter_description> child's current working directory, or %NULL to
-inherit parent's
-</parameter_description>
-</parameter>
-<parameter name="argv">
-<parameter_description> child's argument vector
-</parameter_description>
-</parameter>
-<parameter name="envp">
-<parameter_description> child's environment, or %NULL to inherit parent's
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> flags from #GSpawnFlags
-</parameter_description>
-</parameter>
-<parameter name="child_setup">
-<parameter_description> function to run in the child just before exec()
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> user data for @child_setup
-</parameter_description>
-</parameter>
-<parameter name="child_pid">
-<parameter_description> return location for child process ID, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="standard_input">
-<parameter_description> return location for file descriptor to write to
-child's stdin, or %NULL
+<parameter name="cr">
+<parameter_description> a cairo context
</parameter_description>
</parameter>
-<parameter name="standard_output">
-<parameter_description> return location for file descriptor to read child's
-stdout, or %NULL
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="standard_error">
-<parameter_description> return location for file descriptor to read child's
-stderr, or %NULL
+<parameter name="x">
+<parameter_description> X coordinate of location to place upper left corner of @window
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for error
+<parameter name="y">
+<parameter_description> Y coordinate of location to place upper left corner of @window
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success, %FALSE if an error was set
-
-</return>
+<return></return>
</function>
-<function name="gdk_display_get_default_screen">
+<function name="gdk_color_copy">
<description>
-Get the default #GdkScreen for @display.
+Makes a copy of a color structure.
+
+The result must be freed using gdk_color_free().
-Since: 2.2
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="color">
+<parameter_description> a #GdkColor
</parameter_description>
</parameter>
</parameters>
-<return> the default #GdkScreen object for @display
-
-</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> a copy of @color
</return>
</function>
-<function name="gdk_window_new">
+<function name="gdk_color_equal">
<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.
+Compares two colors.
</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 name="colora">
+<parameter_description> a #GdkColor
</parameter_description>
</parameter>
-<parameter name="attributes_mask">
-<parameter_description> mask indicating which fields in @attributes are valid
+<parameter name="colorb">
+<parameter_description> another #GdkColor
</parameter_description>
</parameter>
</parameters>
-<return> the new #GdkWindow
+<return> %TRUE if the two colors compare equal
</return>
</function>
-<function name="gdk_gc_unref">
+<function name="gdk_color_free">
<description>
-Decrement the reference count of @gc.
-
-Deprecated: 2.0: Use g_object_unref() instead.
+Frees a color structure created with gdk_color_copy().
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC
+<parameter name="color">
+<parameter_description> a #GdkColor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_get_update_area">
+<function name="gdk_color_hash">
<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 gdk_region_destroy() on the returned region if it's non-%NULL.
+A hash function suitable for using for a hash
+table that stores #GdkColors.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="color">
+<parameter_description> a #GdkColor
</parameter_description>
</parameter>
</parameters>
-<return> the update area for @window
+<return> The hash function applied to @color
</return>
</function>
-<function name="gdk_colormap_ref">
+<function name="gdk_color_parse">
<description>
-Deprecated function; use g_object_ref() instead.
+Parses a textual specification of a color and fill in the
+<structfield>red</structfield>, <structfield>green</structfield>,
+and <structfield>blue</structfield> fields of a #GdkColor
+structure.
+
+The string can either one of a large set of standard names
+(taken from the X11 <filename>rgb.txt</filename> file), or
+it can be a hex value in the form '#rgb' '#rrggbb'
+'#rrrgggbbb' or '#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
+'#fff', '#ffffff', '#fffffffff' and
+'#ffffffffffff').
-Deprecated: 2.0: Use g_object_ref() instead.
</description>
<parameters>
-<parameter name="cmap">
-<parameter_description> a #GdkColormap
+<parameter name="spec">
+<parameter_description> the string specifying the color
</parameter_description>
</parameter>
-</parameters>
-<return> the colormap
-
-</return>
-</function>
-
-<function name="gdk_font_unref">
-<description>
-Decreases the reference count of a font by one.
-If the result is zero, destroys the font.
-
-</description>
-<parameters>
-<parameter name="font">
-<parameter_description> a #GdkFont
+<parameter name="color">
+<parameter_description> the #GdkColor to fill in
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the parsing succeeded
+</return>
</function>
-<function name="gdk_offscreen_window_get_pixmap">
+<function name="gdk_color_to_string">
<description>
-Gets the offscreen pixmap that an offscreen window renders into.
-If you need to keep this around over window resizes, you need to
-add a reference to it.
+Returns a textual specification of @color in the hexadecimal form
+<literal>#rrrrggggbbbb</literal>, where <literal>r</literal>,
+<literal>g</literal> and <literal>b</literal> are hex digits
+representing the red, green and blue components respectively.
-Since: 2.18
+The returned string can be parsed by gdk_color_parse().
+
+Since: 2.12
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="color">
+<parameter_description> a #GdkColor
</parameter_description>
</parameter>
</parameters>
-<return> The offscreen pixmap, or %NULL if not offscreen
+<return> a newly-allocated text string
</return>
</function>
-<function name="gdk_window_foreign_new_for_display">
+<function name="gdk_cursor_get_cursor_type">
<description>
-Wraps a native window in a #GdkWindow.
-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.
-
-For example in the X backend, a native window handle is an Xlib
-<type>XID</type>.
+Returns the cursor type for this cursor.
-Since: 2.2
+Since: 2.22
</description>
<parameters>
-<parameter name="display">
-<parameter_description> the #GdkDisplay where the window handle comes from.
-</parameter_description>
-</parameter>
-<parameter name="anid">
-<parameter_description> a native window handle.
+<parameter name="cursor">
+<parameter_description> a #GdkCursor
</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> a #GdkCursorType
</return>
</function>
-<function name="gdk_pango_attr_emboss_color_new">
+<function name="gdk_cursor_get_display">
<description>
-Creates a new attribute specifying the color to emboss text with.
+Returns the display on which the #GdkCursor is defined.
-Since: 2.12
+Since: 2.2
</description>
<parameters>
-<parameter name="color">
-<parameter_description> a GdkColor representing the color to emboss with
+<parameter name="cursor">
+<parameter_description> a #GdkCursor.
</parameter_description>
</parameter>
</parameters>
-<return> new #PangoAttribute
+<return> the #GdkDisplay associated to @cursor
</return>
</function>
-<function name="gdk_x11_drawable_get_xdisplay">
+<function name="gdk_cursor_get_image">
<description>
-Returns the display of a #GdkDrawable.
+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="drawable">
-<parameter_description> a #GdkDrawable.
+<parameter name="cursor">
+<parameter_description> a #GdkCursor
</parameter_description>
</parameter>
</parameters>
-<return> an Xlib <type>Display*</type>.
+<return> a #GdkPixbuf representing @cursor, or %NULL
+
</return>
</function>
-<function name="gdk_utf8_to_string_target">
+<function name="gdk_cursor_new">
<description>
-Convert 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.
+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="str">
-<parameter_description> a UTF-8 string
+<parameter name="cursor_type">
+<parameter_description> cursor to create
</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.)
+<return> a new #GdkCursor
</return>
</function>
-<function name="gdk_display_get_default_cursor_size">
+<function name="gdk_cursor_new_for_display">
<description>
-Returns the default size to use for cursors on @display.
+Creates a new cursor from the set of builtin cursors.
+Some useful ones are:
+<itemizedlist>
+<listitem><para>
+<inlinegraphic format="PNG" fileref="right_ptr.png"></inlinegraphic> #GDK_RIGHT_PTR (right-facing arrow)
+</para></listitem>
+<listitem><para>
+<inlinegraphic format="PNG" fileref="crosshair.png"></inlinegraphic> #GDK_CROSSHAIR (crosshair)
+</para></listitem>
+<listitem><para>
+<inlinegraphic format="PNG" fileref="xterm.png"></inlinegraphic> #GDK_XTERM (I-beam)
+</para></listitem>
+<listitem><para>
+<inlinegraphic format="PNG" fileref="watch.png"></inlinegraphic> #GDK_WATCH (busy)
+</para></listitem>
+<listitem><para>
+<inlinegraphic format="PNG" fileref="fleur.png"></inlinegraphic> #GDK_FLEUR (for moving objects)
+</para></listitem>
+<listitem><para>
+<inlinegraphic format="PNG" fileref="hand1.png"></inlinegraphic> #GDK_HAND1 (a right-pointing hand)
+</para></listitem>
+<listitem><para>
+<inlinegraphic format="PNG" fileref="hand2.png"></inlinegraphic> #GDK_HAND2 (a left-pointing hand)
+</para></listitem>
+<listitem><para>
+<inlinegraphic format="PNG" fileref="left_side.png"></inlinegraphic> #GDK_LEFT_SIDE (resize left side)
+</para></listitem>
+<listitem><para>
+<inlinegraphic format="PNG" fileref="right_side.png"></inlinegraphic> #GDK_RIGHT_SIDE (resize right side)
+</para></listitem>
+<listitem><para>
+<inlinegraphic format="PNG" fileref="top_left_corner.png"></inlinegraphic> #GDK_TOP_LEFT_CORNER (resize northwest corner)
+</para></listitem>
+<listitem><para>
+<inlinegraphic format="PNG" fileref="top_right_corner.png"></inlinegraphic> #GDK_TOP_RIGHT_CORNER (resize northeast corner)
+</para></listitem>
+<listitem><para>
+<inlinegraphic format="PNG" fileref="bottom_left_corner.png"></inlinegraphic> #GDK_BOTTOM_LEFT_CORNER (resize southwest corner)
+</para></listitem>
+<listitem><para>
+<inlinegraphic format="PNG" fileref="bottom_right_corner.png"></inlinegraphic> #GDK_BOTTOM_RIGHT_CORNER (resize southeast corner)
+</para></listitem>
+<listitem><para>
+<inlinegraphic format="PNG" fileref="top_side.png"></inlinegraphic> #GDK_TOP_SIDE (resize top side)
+</para></listitem>
+<listitem><para>
+<inlinegraphic format="PNG" fileref="bottom_side.png"></inlinegraphic> #GDK_BOTTOM_SIDE (resize bottom side)
+</para></listitem>
+<listitem><para>
+<inlinegraphic format="PNG" fileref="sb_h_double_arrow.png"></inlinegraphic> #GDK_SB_H_DOUBLE_ARROW (move vertical splitter)
+</para></listitem>
+<listitem><para>
+<inlinegraphic format="PNG" fileref="sb_v_double_arrow.png"></inlinegraphic> #GDK_SB_V_DOUBLE_ARROW (move horizontal splitter)
+</para></listitem>
+<listitem><para>
+#GDK_BLANK_CURSOR (Blank cursor). Since 2.16
+</para></listitem>
+</itemizedlist>
-Since: 2.4
+Since: 2.2
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<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> the default cursor size.
+<return> a new #GdkCursor
</return>
</function>
-<function name="gdk_colormap_query_color">
+<function name="gdk_cursor_new_from_name">
<description>
-Locates the RGB color in @colormap corresponding to the given
-hardware pixel @pixel. @pixel must be a valid pixel in the
-colormap; it's a programmer error to call this function with a
-pixel which is not in the colormap. Hardware pixels are normally
-obtained from gdk_colormap_alloc_colors(), or from a #GdkImage. (A
-#GdkImage contains image data in hardware format, a #GdkPixbuf
-contains image data in a canonical 24-bit RGB format.)
-
-This function is rarely useful; it's used for example to
-implement the eyedropper feature in #GtkColorSelection.
+Creates a new cursor by looking up @name in the current cursor
+theme.
+Since: 2.8
</description>
<parameters>
-<parameter name="colormap">
-<parameter_description> a #GdkColormap
-</parameter_description>
-</parameter>
-<parameter name="pixel">
-<parameter_description> pixel value in hardware display format
+<parameter name="display">
+<parameter_description> the #GdkDisplay for which the cursor will be created
</parameter_description>
</parameter>
-<parameter name="result">
-<parameter_description> #GdkColor with red, green, blue fields initialized
+<parameter name="name">
+<parameter_description> the name of the cursor
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GdkCursor, or %NULL if there is no cursor with
+the given name
+
+</return>
</function>
-<function name="gdk_screen_get_number">
+<function name="gdk_cursor_new_from_pixbuf">
<description>
-Gets the index of @screen among the screens in the display
-to which it belongs. (See gdk_screen_get_display())
+Creates a new cursor from a pixbuf.
-Since: 2.2
+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.
-</description>
-<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
-</parameter_description>
-</parameter>
-</parameters>
-<return> the index
+If @x or @y are <literal>-1</literal>, the pixbuf must have
+options named "x_hot" and "y_hot", resp., containing
+integer values between %0 and the width resp. height of
+the pixbuf. (Since: 3.0)
-</return>
-</function>
+On the X backend, support for RGBA cursors requires a
+sufficently new version of the X Render extension.
-<function name="gdk_colormap_free_colors">
-<description>
-Frees previously allocated colors.
+Since: 2.4
</description>
<parameters>
-<parameter name="colormap">
-<parameter_description> a #GdkColormap.
+<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="colors">
-<parameter_description> the colors to free.
+<parameter name="x">
+<parameter_description> the horizontal offset of the 'hotspot' of the cursor.
</parameter_description>
</parameter>
-<parameter name="n_colors">
-<parameter_description> the number of colors in @colors.
+<parameter name="y">
+<parameter_description> the vertical offset of the 'hotspot' of the cursor.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GdkCursor.
+
+</return>
</function>
-<function name="gdk_test_simulate_key">
+<function name="gdk_cursor_ref">
<description>
-This function is intended to be used in Gtk+ test programs.
-If (@x,@y) are > (-1,-1), it will warp the mouse pointer to
-the given (@x,@y) corrdinates 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, gtk_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.
+Adds a reference to @cursor.
+Deprecated: 3.0: Use g_object_ref() instead
</description>
<parameters>
-<parameter name="window">
-<parameter_description> Gdk window 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 name="cursor">
+<parameter_description> a #GdkCursor
</parameter_description>
</parameter>
</parameters>
-<return> wether all actions neccessary for a key event simulation were carried out successfully.
+<return> Same @cursor that was passed in
+
</return>
</function>
-<function name="gdk_x11_window_set_user_time">
+<function name="gdk_cursor_unref">
<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 "pop-up" 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.
+Removes a reference from @cursor, deallocating the cursor
+if no references remain.
-Since: 2.6
+Deprecated: 3.0: Use g_object_unref() instead
</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 name="cursor">
+<parameter_description> a #GdkCursor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_configure_finished">
+<function name="gdk_device_free_history">
<description>
-Signal to the window system that the application has finished
-handling Configure events it has received. Window Managers can
-use this to better synchronize the frame repaint with the
-application. GTK+ applications will automatically call this
-function when appropriate.
-
-This function can only be called if gdk_window_enable_synchronized_configure()
-was called previously.
-
-Since: 2.6
+Frees an array of #GdkTimeCoord that was returned by gdk_device_get_history().
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<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_screen_get_n_monitors">
+<function name="gdk_device_get_associated_device">
<description>
-Returns the number of monitors which @screen consists of.
+Returns the associated device to @device, if @device is of type
+%GDK_DEVICE_TYPE_MASTER, it will return the paired pointer or
+keyboard.
-Since: 2.2
+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="screen">
-<parameter_description> a #GdkScreen
+<parameter name="device">
+<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
-<return> number of monitors which @screen consists of
+<return> The associated device, or %NULL
</return>
</function>
-<function name="gdk_screen_get_setting">
+<function name="gdk_device_get_axis">
<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.
+Interprets an array of double as axis values for a given device,
+and locates the value in the array for a given axis use.
-Since: 2.2
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> the #GdkScreen where the setting is located
+<parameter name="device">
+<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
-<parameter name="name">
-<parameter_description> the name of the setting
+<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 value of the setting
+<parameter_description> location to store the found value.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the setting existed and a value was stored
-in @value, %FALSE otherwise.
-
+<return> %TRUE if the given axis use was found, otherwise %FALSE
</return>
</function>
-<function name="gdk_display_supports_cursor_color">
+<function name="gdk_device_get_axis_use">
<description>
-Returns %TRUE if multicolored cursors are supported
-on @display. Otherwise, cursors have only a forground
-and a background color.
+Returns the axis use for @index_.
-Since: 2.4
+Since: 2.20
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<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> whether cursors can have multiple colors.
+<return> a #GdkAxisUse specifying how the axis is used.
</return>
</function>
-<function name="gdk_font_equal">
+<function name="gdk_device_get_axis_value">
<description>
-Compares two fonts for equality. Single fonts compare equal
-if they have the same X font ID. This operation does
-not currently work correctly for fontsets.
+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="fonta">
-<parameter_description> a #GdkFont.
+<parameter name="device">
+<parameter_description> a pointer #GdkDevice.
</parameter_description>
</parameter>
-<parameter name="fontb">
-<parameter_description> another #GdkFont.
+<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 fonts are equal.
+<return> %TRUE if the given axis use was found, otherwise %FALSE.
+
</return>
</function>
-<function name="gdk_gc_set_tile">
+<function name="gdk_device_get_device_type">
<description>
-Set a tile pixmap for a graphics context.
-This will only be used if the fill mode
-is %GDK_TILED.
-
-</description>
-<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
-</parameter_description>
-</parameter>
-<parameter name="tile">
-<parameter_description> the new tile pixmap.
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
+Returns the device type for @device.
-<function name="gdk_gc_set_line_attributes">
-<description>
-Sets various attributes of how lines are drawn. See
-the corresponding members of #GdkGCValues for full
-explanations of the arguments.
+Since: 3.0
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
-</parameter_description>
-</parameter>
-<parameter name="line_width">
-<parameter_description> the width of lines.
-</parameter_description>
-</parameter>
-<parameter name="line_style">
-<parameter_description> the dash-style for lines.
-</parameter_description>
-</parameter>
-<parameter name="cap_style">
-<parameter_description> the manner in which the ends of lines are drawn.
-</parameter_description>
-</parameter>
-<parameter name="join_style">
-<parameter_description> the in which lines are joined together.
+<parameter name="device">
+<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GdkDeviceType for @device.
+
+</return>
</function>
-<function name="gdk_char_width">
+<function name="gdk_device_get_display">
<description>
-Determines the width of a given character.
+Returns the #GdkDisplay to which @device pertains.
-Deprecated: 2.2: Use gdk_text_extents() instead.
+Since: 3.0
</description>
<parameters>
-<parameter name="font">
-<parameter_description> a #GdkFont
-</parameter_description>
-</parameter>
-<parameter name="character">
-<parameter_description> the character to measure.
+<parameter name="device">
+<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
-<return> the width of the character in pixels.
+<return> a #GdkDisplay. This memory is owned
+by GTK+, and must not be freed or unreffed.
</return>
</function>
-<function name="gdk_gc_set_rgb_fg_color">
+<function name="gdk_device_get_has_cursor">
<description>
-Set the foreground color of a GC using an unallocated color. The
-pixel value for the color will be determined using GdkRGB. If the
-colormap for the GC has not previously been initialized for GdkRGB,
-then for pseudo-color colormaps (colormaps with a small modifiable
-number of colors), a colorcube will be allocated in the colormap.
+Determines whether the pointer follows device motion.
-Calling this function for a GC without a colormap is an error.
+Since: 2.20
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC
-</parameter_description>
-</parameter>
-<parameter name="color">
-<parameter_description> an unallocated #GdkColor.
+<parameter name="device">
+<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the pointer follows device motion
+
+</return>
</function>
-<function name="gdk_window_begin_move_drag">
+<function name="gdk_device_get_history">
<description>
-Begins a window move operation (for a toplevel window). You might
-use this function to implement a "window move grip," for
-example. The function works best with window managers that support
-the <ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended
-Window Manager Hints</ulink>, but has a fallback implementation for
-other window managers.
+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> a toplevel #GdkWindow
+<parameter_description> the window with respect to which which the event coordinates will be reported
</parameter_description>
</parameter>
-<parameter name="button">
-<parameter_description> the button being used to drag
+<parameter name="start">
+<parameter_description> starting timestamp for range of events to return
</parameter_description>
</parameter>
-<parameter name="root_x">
-<parameter_description> root window X coordinate of mouse click that began the drag
+<parameter name="stop">
+<parameter_description> ending timestamp for the range of events to return
</parameter_description>
</parameter>
-<parameter name="root_y">
-<parameter_description> root window Y coordinate of mouse click that began the drag
+<parameter name="events">
+<parameter_description> location to store a newly-allocated array of #GdkTimeCoord, or %NULL
</parameter_description>
</parameter>
-<parameter name="timestamp">
-<parameter_description> timestamp of mouse click that began the drag
+<parameter name="n_events">
+<parameter_description> location to store the length of @events, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the windowing system supports motion history and
+at least one event was found.
+</return>
</function>
-<function name="gdk_visual_get_best_depth">
+<function name="gdk_device_get_key">
<description>
-Get the best available depth for the default GDK screen. "Best"
-means "largest," i.e. 32 preferred over 24 preferred over 8 bits
-per pixel.
+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> best available depth
+<return> %TRUE if keyval is set for @index.
+
</return>
</function>
-<function name="gdk_colors_store">
+<function name="gdk_device_get_mode">
<description>
-Changes the value of the first @ncolors colors in
-a private colormap. This function is obsolete and
-should not be used. See gdk_color_change().
+Determines the mode of the device.
+
+Since: 2.20
</description>
<parameters>
-<parameter name="colormap">
-<parameter_description> a #GdkColormap.
-</parameter_description>
-</parameter>
-<parameter name="colors">
-<parameter_description> the new color values.
-</parameter_description>
-</parameter>
-<parameter name="ncolors">
-<parameter_description> the number of colors to change.
+<parameter name="device">
+<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GdkInputSource
+
+</return>
</function>
-<function name="gdk_cairo_reset_clip">
+<function name="gdk_device_get_n_axes">
<description>
-Resets the clip region for a Cairo context created by gdk_cairo_create().
-
-This resets the clip region to the "empty" state for the given drawable.
-This is required for non-native windows since a direct call to
-cairo_reset_clip() would unset the clip region inherited from the
-drawable (i.e. the window clip region), and thus let you e.g.
-draw outside your window.
-
-This is rarely needed though, since most code just create a new cairo_t
-using gdk_cairo_create() each time they want to draw something.
+Returns the number of axes the device currently has.
-Since: 2.18
+Since: 3.0
</description>
<parameters>
-<parameter name="cr">
-<parameter_description> a #cairo_t
-</parameter_description>
-</parameter>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<parameter name="device">
+<parameter_description> a pointer #GdkDevice
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the number of axes.
+
+</return>
</function>
-<function name="gdk_set_double_click_time">
+<function name="gdk_device_get_n_keys">
<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 <emphasis>not</emphasis> set this, it is a
-global user-configured setting.
+Returns the number of keys the device currently has.
+
+Since: 2.24
</description>
<parameters>
-<parameter name="msec">
-<parameter_description> double click time in milliseconds (thousandths of a second)
+<parameter name="device">
+<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the number of keys.
+
+</return>
</function>
-<function name="gdk_font_load">
+<function name="gdk_device_get_name">
<description>
-Loads a font.
-
-The font may be newly loaded or looked up the font in a cache.
-You should make no assumptions about the initial reference count.
+Determines the name of the device.
+Since: 2.20
</description>
<parameters>
-<parameter name="font_name">
-<parameter_description> a XLFD describing the font to load.
+<parameter name="device">
+<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkFont, or %NULL if the font could not be loaded.
+<return> a name
+
</return>
</function>
-<function name="gdk_region_spans_intersect_foreach">
+<function name="gdk_device_get_position">
<description>
-Calls a function on each span in the intersection of @region and @spans.
+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="region">
-<parameter_description> a #GdkRegion
-</parameter_description>
-</parameter>
-<parameter name="spans">
-<parameter_description> an array of #GdkSpans
-</parameter_description>
-</parameter>
-<parameter name="n_spans">
-<parameter_description> the length of @spans
+<parameter name="device">
+<parameter_description> pointer device to query status about.
</parameter_description>
</parameter>
-<parameter name="sorted">
-<parameter_description> %TRUE if @spans is sorted wrt. the y coordinate
+<parameter name="screen">
+<parameter_description> location to store the #GdkScreen
+the @device is on, or %NULL.
</parameter_description>
</parameter>
-<parameter name="function">
-<parameter_description> function to call on each span in the intersection
+<parameter name="x">
+<parameter_description> location to store root window X coordinate of @device, or %NULL.
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @function
+<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_display_supports_shapes">
+<function name="gdk_device_get_source">
<description>
-Returns %TRUE if gdk_window_shape_combine_mask() can
-be used to create shaped windows on @display.
+Determines the type of the device.
-Since: 2.10
+Since: 2.20
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="device">
+<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if shaped windows are supported
+<return> a #GdkInputSource
</return>
</function>
-<function name="gdk_rectangle_union">
+<function name="gdk_device_get_state">
<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.
+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="src1">
-<parameter_description> a #GdkRectangle
+<parameter name="device">
+<parameter_description> a #GdkDevice.
</parameter_description>
</parameter>
-<parameter name="src2">
-<parameter_description> a #GdkRectangle
+<parameter name="window">
+<parameter_description> a #GdkWindow.
</parameter_description>
</parameter>
-<parameter name="dest">
-<parameter_description> return location for the union of @src1 and @src2
+<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_axis">
+<function name="gdk_device_get_window_at_position">
<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.
+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> a #GdkDevice
+<parameter_description> pointer #GdkDevice to query info to.
</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 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="value">
-<parameter_description> location to store the found value.
+<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> %TRUE if the given axis use was found, otherwise %FALSE
+<return> the #GdkWindow under the device position, or %NULL.
+
</return>
</function>
-<function name="gdk_pixmap_create_from_xpm_d">
+<function name="gdk_device_grab">
<description>
-Create a pixmap from data in XPM format.
+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="drawable">
-<parameter_description> a #GdkDrawable, used to determine default values
-for the new pixmap.
+<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="mask">
-<parameter_description> Pointer to a place to store a bitmap representing
-the transparency mask of the XPM file. Can be %NULL,
-in which case transparency will be ignored.
+<parameter name="window">
+<parameter_description> the #GdkWindow which will own the grab (the grab window)
</parameter_description>
</parameter>
-<parameter name="transparent_color">
-<parameter_description> This color will be used for the pixels
-that are transparent in the input file. Can be %NULL
-in which case a default color will be used.
+<parameter name="grab_ownership">
+<parameter_description> specifies the grab ownership.
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> Pointer to a string containing the XPM data.
+<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> the #GdkPixmap.
+<return> %GDK_GRAB_SUCCESS if the grab was successful.
+
</return>
</function>
-<function name="gdk_set_show_events">
+<function name="gdk_device_grab_info_libgtk_only">
<description>
-Sets whether a trace of received events is output.
-Note that GTK+ must be compiled with debugging (that is,
-configured using the <option>--enable-debug</option> option)
-to use this option.
+Determines information about the current keyboard grab.
+This is not public API and must not be used by applications.
+
</description>
<parameters>
-<parameter name="show_events">
-<parameter_description> %TRUE to output event debugging information.
+<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></return>
+<return> %TRUE if this application currently has the
+keyboard grabbed.
+</return>
</function>
-<function name="gdk_x11_get_server_time">
+<function name="gdk_device_list_axes">
<description>
-Routine to get the current X server time stamp.
+Returns a #GList of #GdkAtom<!-- -->s, containing the labels for
+the axes that @device currently has.
+Since: 3.0
</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 name="device">
+<parameter_description> a pointer #GdkDevice
</parameter_description>
</parameter>
</parameters>
-<return> the time stamp.
+<return>
+A #GList of #GdkAtom<!-- -->s, free with g_list_free().
+
</return>
</function>
-<function name="gdk_x11_ungrab_server">
+<function name="gdk_device_list_slave_devices">
<description>
-Ungrab the default display after it has been grabbed with
-gdk_x11_grab_server().
+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></return>
-</function>
+<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_window_get_position">
+<function name="gdk_device_manager_get_client_pointer">
<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.
+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.
-The position coordinates are relative to the window's parent window.
+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="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 name="device_manager">
+<parameter_description> a #GdkDeviceManager
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The client pointer. This memory is
+owned by GDK and must not be freed or unreferenced.
+
+</return>
</function>
-<function name="gdk_cursor_ref">
+<function name="gdk_device_manager_get_display">
<description>
-Adds a reference to @cursor.
+Gets the #GdkDisplay associated to @device_manager.
+Since: 3.0
</description>
<parameters>
-<parameter name="cursor">
-<parameter_description> a #GdkCursor
+<parameter name="device_manager">
+<parameter_description> a #GdkDeviceManager
</parameter_description>
</parameter>
</parameters>
-<return> Same @cursor that was passed in
+<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_region_xor">
+<function name="gdk_device_manager_list_devices">
<description>
-Sets the area of @source1 to the exclusive-OR of the areas of @source1
-and @source2. The resulting area is the set of pixels contained in one
-or the other of the two sources but not in both.
+Returns the list of devices of type @type currently attached to
+ device_manager
+
+Since: 3.0
</description>
<parameters>
-<parameter name="source1">
-<parameter_description> a #GdkRegion
+<parameter name="device_manager">
+<parameter_description> a #GdkDeviceManager
</parameter_description>
</parameter>
-<parameter name="source2">
-<parameter_description> another #GdkRegion
+<parameter name="type">
+<parameter_description> device type to get.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a list of
+#GdkDevice<!-- -->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_drag_abort">
+<function name="gdk_device_set_axis_use">
<description>
-Aborts a drag without dropping.
-
-This function is called by the drag source.
+Specifies how an axis of a device is used.
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GdkDragContext.
+<parameter name="device">
+<parameter_description> a pointer #GdkDevice
</parameter_description>
</parameter>
-<parameter name="time_">
-<parameter_description> the timestamp for this operation.
+<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_draw_layout_with_colors">
+<function name="gdk_device_set_key">
<description>
-Render a #PangoLayout onto a #GdkDrawable, overriding the
-layout's normal colors with @foreground and/or @background.
- foreground and @background need not be allocated.
-
-If the layout's #PangoContext has a transformation matrix set, then
- x and @y specify the position of the top left corner of the
-bounding box (in device space) of the transformed layout.
-
-If you're using GTK+, the ususal way to obtain a #PangoLayout
-is gtk_widget_create_pango_layout().
+Specifies the X key event to generate when a macro button of a device
+is pressed.
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> the drawable on which to draw string
-</parameter_description>
-</parameter>
-<parameter name="gc">
-<parameter_description> base graphics context to use
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the X position of the left of the layout (in pixels)
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> the Y position of the top of the layout (in pixels)
+<parameter name="device">
+<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
-<parameter name="layout">
-<parameter_description> a #PangoLayout
+<parameter name="index_">
+<parameter_description> the index of the macro button to set
</parameter_description>
</parameter>
-<parameter name="foreground">
-<parameter_description> foreground override color, or %NULL for none
+<parameter name="keyval">
+<parameter_description> the keyval to generate
</parameter_description>
</parameter>
-<parameter name="background">
-<parameter_description> background override color, or %NULL for none
+<parameter name="modifiers">
+<parameter_description> the modifiers to set
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_pixbuf_get_from_drawable">
+<function name="gdk_device_set_mode">
<description>
-Transfers image data from a #GdkDrawable 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.
-
-If the drawable @src has no colormap (gdk_drawable_get_colormap()
-returns %NULL), then a suitable colormap must be specified.
-Typically a #GdkWindow or a pixmap created by passing a #GdkWindow
-to gdk_pixmap_new() will already have a colormap associated with
-it. If the drawable has a colormap, the @cmap argument will be
-ignored. If the drawable is a bitmap (1 bit per pixel pixmap),
-then a colormap is not required; pixels with a value of 1 are
-assumed to be white, and pixels with a value of 0 are assumed to be
-black. For taking screenshots, gdk_colormap_get_system() returns
-the correct colormap to use.
-
-If the specified destination pixbuf @dest is %NULL, then this
-function will create an RGB pixbuf with 8 bits per channel and no
-alpha, with the same size specified by the @width and @height
-arguments. In this case, the @dest_x and @dest_y arguments must be
-specified as 0. If the specified destination pixbuf is not %NULL
-and it contains alpha information, then the filled pixels will be
-set to full opacity (alpha = 255).
-
-If the specified drawable is a pixmap, then the requested source
-rectangle must be completely contained within the pixmap, otherwise
-the function will return %NULL. For pixmaps only (not for windows)
-passing -1 for width or height is allowed to mean the full width
-or height of the pixmap.
-
-If the specified drawable is a window, and 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 target drawable 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.)
-
-This function calls gdk_drawable_get_image() internally and
-converts the resulting image to a #GdkPixbuf, so the
-documentation for gdk_drawable_get_image() may also be relevant.
+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="dest">
-<parameter_description> Destination pixbuf, or %NULL if a new pixbuf should be created.
-</parameter_description>
-</parameter>
-<parameter name="src">
-<parameter_description> Source drawable.
-</parameter_description>
-</parameter>
-<parameter name="cmap">
-<parameter_description> A colormap if @src doesn't have one set.
-</parameter_description>
-</parameter>
-<parameter name="src_x">
-<parameter_description> Source X coordinate within drawable.
-</parameter_description>
-</parameter>
-<parameter name="src_y">
-<parameter_description> Source Y coordinate within drawable.
-</parameter_description>
-</parameter>
-<parameter name="dest_x">
-<parameter_description> Destination X coordinate in pixbuf, or 0 if @dest is NULL.
-</parameter_description>
-</parameter>
-<parameter name="dest_y">
-<parameter_description> Destination Y coordinate in pixbuf, or 0 if @dest is NULL.
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> Width in pixels of region to get.
+<parameter name="device">
+<parameter_description> a #GdkDevice.
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> Height in pixels of region to get.
+<parameter name="mode">
+<parameter_description> the input mode.
</parameter_description>
</parameter>
</parameters>
-<return> The same pixbuf as @dest if it was non-%NULL, or a newly-created
-pixbuf with a reference count of 1 if no destination pixbuf was specified, or %NULL on error
+<return> %TRUE if the mode was successfully changed.
</return>
</function>
-<function name="gdk_screen_width_mm">
+<function name="gdk_device_ungrab">
<description>
-Returns the width of the default screen in millimeters.
-Note that on many X servers this value will not be correct.
+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> the width of the default screen in millimeters,
-though it is not always correct.
-</return>
+<return></return>
</function>
-<function name="gdk_text_property_to_text_list_for_display">
+<function name="gdk_device_warp">
<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.)
+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.
-Since: 2.2
+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="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 name="device">
+<parameter_description> the device to warp.
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> The text data.
+<parameter name="screen">
+<parameter_description> the screen to warp @device to.
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> The number of items to transform.
+<parameter name="x">
+<parameter_description> the X coordinate of the destination.
</parameter_description>
</parameter>
-<parameter name="list">
-<parameter_description> location to store a terminated array of strings in
-the encoding of the current locale. This array should be
-freed using gdk_free_text_list().
+<parameter name="y">
+<parameter_description> the Y coordinate of the destination.
</parameter_description>
</parameter>
</parameters>
-<return> the number of strings stored in list, or 0,
-if the conversion failed.
-
-</return>
+<return></return>
</function>
-<function name="gdk_screen_get_toplevel_windows">
+<function name="gdk_disable_multidevice">
<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()).
+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.
-The returned list should be freed with g_list_free(), but
-its elements need not be freed.
+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="screen">
-<parameter_description> The #GdkScreen where the toplevels are located.
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return> list of toplevel windows, free with g_list_free()
-
-</return>
+<return></return>
</function>
-<function name="gdk_display_set_double_click_distance">
+<function name="gdk_display_close">
<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 <emphasis>not</emphasis> set this, it is a global
-user-configured setting.
+Closes the connection to the windowing system for the given display,
+and cleans up associated resources.
-Since: 2.4
+Since: 2.2
</description>
<parameters>
@@ -1874,42 +1696,43 @@ Since: 2.4
<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_drag_get_protocol">
+<function name="gdk_display_device_is_grabbed">
<description>
-Finds out the DND protocol supported by a window.
+Returns %TRUE if there is an ongoing grab on @device for @display.
</description>
<parameters>
-<parameter name="xid">
-<parameter_description> the windowing system id of the destination window.
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="protocol">
-<parameter_description> location where the supported DND protocol is returned.
+<parameter name="device">
+<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
-<return> the windowing system specific id for the window where
-the drop should happen. This may be @xid or the id of a proxy
-window, or zero if @xid doesn't support Drag and Drop.
+<return> %TRUE if there is a grab in effect for @device.
</return>
</function>
-<function name="gdk_x11_display_ungrab">
+<function name="gdk_display_flush">
<description>
-Ungrab @display after it has been grabbed with
-gdk_x11_display_grab().
+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.
-Since: 2.2
+This is most useful for X11. On windowing systems where requests are
+handled synchronously, this function will do nothing.
+
+Since: 2.4
</description>
<parameters>
@@ -1921,14 +1744,12 @@ Since: 2.2
<return></return>
</function>
-<function name="gdk_x11_display_get_user_time">
+<function name="gdk_display_get_app_launch_context">
<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().
+Returns a #GdkAppLaunchContext suitable for launching
+applications on the given display.
-Since: 2.8
+Since: 3.0
</description>
<parameters>
@@ -1937,63 +1758,54 @@ Since: 2.8
</parameter_description>
</parameter>
</parameters>
-<return> the timestamp of the last user interaction
+<return> a new #GdkAppLaunchContext for @display.
+Free with g_object_unref() when done
</return>
</function>
-<function name="gdk_x11_image_get_xdisplay">
+<function name="gdk_display_get_default">
<description>
-Returns the display of a #GdkImage.
+Gets the default #GdkDisplay. This is a convenience
+function for
+<literal>gdk_display_manager_get_default_display (gdk_display_manager_get ())</literal>.
+Since: 2.2
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GdkImage.
-</parameter_description>
-</parameter>
</parameters>
-<return> an Xlib <type>Display*</type>.
+<return> a #GdkDisplay, or %NULL if there is no default
+display.
+
</return>
</function>
-<function name="gdk_cairo_set_source_pixmap">
+<function name="gdk_display_get_default_cursor_size">
<description>
-Sets the given pixmap as the source pattern for the Cairo context.
-The pattern has an extend mode of %CAIRO_EXTEND_NONE and is aligned
-so that the origin of @pixmap is @pixmap_x, @pixmap_y
+Returns the default size to use for cursors on @display.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="cr">
-<parameter_description> a #Cairo context
-</parameter_description>
-</parameter>
-<parameter name="pixmap">
-<parameter_description> a #GdkPixmap
-</parameter_description>
-</parameter>
-<parameter name="pixmap_x">
-<parameter_description> X coordinate of location to place upper left corner of @pixmap
-</parameter_description>
-</parameter>
-<parameter name="pixmap_y">
-<parameter_description> Y coordinate of location to place upper left corner of @pixmap
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the default cursor size.
+
+</return>
</function>
-<function name="gdk_display_put_event">
+<function name="gdk_display_get_default_group">
<description>
-Appends a copy of the given event onto the front of the event
-queue for @display.
+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.2
+Since: 2.4
</description>
<parameters>
@@ -2001,676 +1813,542 @@ Since: 2.2
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="event">
-<parameter_description> a #GdkEvent.
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> The default group leader window
+for @display
+
+</return>
</function>
-<function name="gdk_gc_set_colormap">
+<function name="gdk_display_get_default_screen">
<description>
-Sets the colormap for the GC to the given colormap. The depth
-of the colormap's visual must match the depth of the drawable
-for which the GC was created.
+Get the default #GdkScreen for @display.
+
+Since: 2.2
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="colormap">
-<parameter_description> a #GdkColormap
+</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></return>
+<return> A #GdkDeviceManager, or %NULL. This memory is
+owned by GDK and must not be freed or unreferenced.
+
+</return>
</function>
-<function name="gdk_screen_height_mm">
+<function name="gdk_display_get_event">
<description>
-Returns the height of the default screen in millimeters.
-Note that on many X servers this value will not be correct.
+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 height of the default screen in millimeters,
-though it is not always correct.
+<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_gc_set_font">
+<function name="gdk_display_get_maximal_cursor_size">
<description>
-Sets the font for a graphics context. (Note that
-all text-drawing functions in GDK take a @font
-argument; the value set here is used when that
-argument is %NULL.)
+Gets the maximal size to use for cursors on @display.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
+<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="font">
-<parameter_description> the new font.
+<parameter name="height">
+<parameter_description> the return location for the maximal cursor height
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_screen_get_default_colormap">
+<function name="gdk_display_get_n_screens">
<description>
-Gets the default colormap for @screen.
+Gets the number of screen managed by the @display.
Since: 2.2
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return> the default #GdkColormap.
+<return> number of screens.
</return>
</function>
-<function name="gdk_offscreen_window_get_embedder">
+<function name="gdk_display_get_name">
<description>
-Gets the window that @window is embedded in.
+Gets the name of the display.
-Since: 2.18
+Since: 2.2
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return> the embedding #GdkWindow, or %NULL if @window is not an
-embedded offscreen window
+<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_mbstowcs">
+<function name="gdk_display_get_pointer">
<description>
-Converts a multi-byte string to a wide character string.
-(The function name comes from an acronym of 'Multi-Byte String TO Wide
-Character String').
+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="dest">
-<parameter_description> the space to place the converted wide character string into.
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="src">
-<parameter_description> the multi-byte string to convert, which must be nul-terminated.
+<parameter name="screen">
+<parameter_description> location to store the screen that the
+cursor is on, or %NULL.
</parameter_description>
</parameter>
-<parameter name="dest_max">
-<parameter_description> the maximum number of wide characters to place in @dest.
+<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> the number of wide characters written into @dest, or -1 if
-the conversion failed.
-</return>
+<return></return>
</function>
-<function name="gdk_window_set_opacity">
+<function name="gdk_display_get_screen">
<description>
-Request the windowing system to make @window partially transparent,
-with opacity 0 being fully transparent and 1 fully opaque. (Values
-of the opacity parameter are clamped to the [0,1] range.)
-
-On X11, this works only on X screens with a compositing manager
-running.
-
-For setting up per-pixel alpha, see gdk_screen_get_rgba_colormap().
-For making non-toplevel windows translucent, see
-gdk_window_set_composited().
+Returns a screen object for one of the screens of the display.
-Since: 2.12
+Since: 2.2
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a top-level #GdkWindow
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="opacity">
-<parameter_description> opacity
+<parameter name="screen_num">
+<parameter_description> the screen number
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GdkScreen object
+
+</return>
</function>
-<function name="gdk_pango_context_set_colormap">
+<function name="gdk_display_get_window_at_pointer">
<description>
-This function used to set the colormap to be used for drawing with
- context The colormap is now always derived from the graphics
-context used for drawing, so calling this function is no longer
-necessary.
+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="context">
-<parameter_description> a #PangoContext
+<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="colormap">
-<parameter_description> a #GdkColormap
+<parameter name="win_y">
+<parameter_description> return location for y coordinate of the pointer location relative
+ & to the window origin, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the window under the mouse pointer, or %NULL
+
+</return>
</function>
-<function name="gdk_window_geometry_changed">
+<function name="gdk_display_has_pending">
<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.
+Returns whether the display has events that are waiting
+to be processed.
-Since: 2.18
+Since: 3.0
</description>
<parameters>
-<parameter name="window">
-<parameter_description> an embedded offscreen #GdkWindow
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if there are events ready to be processed.
+
+</return>
</function>
-<function name="gdk_threads_add_timeout_full">
+<function name="gdk_display_is_closed">
<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.
+Finds out if the display has been closed.
-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->timeout_id = 0;
-
-return FALSE;
-}
+Since: 2.22
-static void some_widget_do_stuff_later (SomeWidget *self)
-{
-self->timeout_id = g_timeout_add (timeout_callback, self)
-}
+</description>
+<parameters>
+<parameter name="display">
+<parameter_description> a #GdkDisplay
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the display is closed.
-static void some_widget_finalize (GObject *object)
-{
-SomeWidget *self = SOME_WIDGET (object);
+</return>
+</function>
-if (self->timeout_id)
-g_source_remove (self->timeout_id);
+<function name="gdk_display_keyboard_ungrab">
+<description>
+Release any keyboard grab
-G_OBJECT_CLASS (parent_class)->finalize (object);
-}
-]|
+Since: 2.2
-Since: 2.12
+Deprecated: 3.0: Use gdk_device_ungrab(), together with gdk_device_grab()
+instead.
</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 name="display">
+<parameter_description> a #GdkDisplay.
</parameter_description>
</parameter>
-<parameter name="notify">
-<parameter_description> function to call when the timeout is removed, or %NULL
+<parameter name="time_">
+<parameter_description> a timestap (e.g #GDK_CURRENT_TIME).
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
-
-</return>
+<return></return>
</function>
-<function name="gdk_threads_init">
+<function name="gdk_display_list_devices">
<description>
-Initializes GDK so that it can be used from multiple threads
-in conjunction with gdk_threads_enter() and gdk_threads_leave().
-g_thread_init() must be called previous to this function.
+Returns the list of available input devices attached to @display.
+The list is statically allocated and should not be freed.
-This call must be made before any use of the main loop from
-GTK+; to be safe, call it before gtk_init().
+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></return>
+<return>
+a list of #GdkDevice
+
+</return>
</function>
-<function name="gdk_draw_pixbuf">
+<function name="gdk_display_manager_get">
<description>
-Renders a rectangular portion of a pixbuf to a drawable. The destination
-drawable must have a colormap. All windows have a colormap, however, pixmaps
-only have colormap by default if they were created with a non-%NULL window
-argument. Otherwise a colormap must be set on them with
-gdk_drawable_set_colormap().
-
-On older X servers, rendering pixbufs with an alpha channel involves round
-trips to the X server, and may be somewhat slow.
+Gets the singleton #GdkDisplayManager object.
-If GDK is built with the Sun mediaLib library, the gdk_draw_pixbuf
-function is accelerated using mediaLib, which provides hardware
-acceleration on Intel, AMD, and Sparc chipsets. If desired, mediaLib
-support can be turned off by setting the GDK_DISABLE_MEDIALIB environment
-variable.
+When called for the first time, this function consults the
+<envar>GDK_BACKEND</envar> 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>
-<parameter name="drawable">
-<parameter_description> Destination drawable.
-</parameter_description>
-</parameter>
-<parameter name="gc">
-<parameter_description> a #GdkGC, used for clipping, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf
-</parameter_description>
-</parameter>
-<parameter name="src_x">
-<parameter_description> Source X coordinate within pixbuf.
-</parameter_description>
-</parameter>
-<parameter name="src_y">
-<parameter_description> Source Y coordinates within pixbuf.
-</parameter_description>
-</parameter>
-<parameter name="dest_x">
-<parameter_description> Destination X coordinate within drawable.
-</parameter_description>
-</parameter>
-<parameter name="dest_y">
-<parameter_description> Destination Y coordinate within drawable.
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> Width of region to render, in pixels, or -1 to use pixbuf width.
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> Height of region to render, in pixels, or -1 to use pixbuf height.
-</parameter_description>
-</parameter>
-<parameter name="dither">
-<parameter_description> Dithering mode for #GdkRGB.
-</parameter_description>
-</parameter>
-<parameter name="x_dither">
-<parameter_description> X offset for dither.
-</parameter_description>
-</parameter>
-<parameter name="y_dither">
-<parameter_description> Y offset for dither.
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> The global #GdkDisplayManager singleton;
+gdk_parse_args(), gdk_init(), or gdk_init_check() must have
+been called first.
+
+</return>
</function>
-<function name="gdk_x11_atom_to_xatom_for_display">
+<function name="gdk_display_manager_get_default_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.
+Gets the default #GdkDisplay.
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 name="manager">
+<parameter_description> a #GdkDisplayManager
</parameter_description>
</parameter>
</parameters>
-<return> the X atom corresponding to @atom, or %None
+<return> a #GdkDisplay, or %NULL
+if there is no default display.
</return>
</function>
-<function name="gdk_window_get_internal_paint_info">
+<function name="gdk_display_manager_list_displays">
<description>
-If you bypass the GDK layer and use windowing system primitives to
-draw directly onto a #GdkWindow, then you need to deal with two
-details: there may be an offset between GDK coordinates and windowing
-system coordinates, and GDK may have redirected drawing to a offscreen
-pixmap as the result of a gdk_window_begin_paint_region() calls.
-This function allows retrieving the information you need to compensate
-for these effects.
+List all currently open displays.
-This function exposes details of the GDK implementation, and is thus
-likely to change in future releases of GDK.
+Since: 2.2
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="real_drawable">
-<parameter_description> location to store the drawable to which drawing should be
-done.
-</parameter_description>
-</parameter>
-<parameter name="x_offset">
-<parameter_description> location to store the X offset between coordinates in @window,
-and the underlying window system primitive coordinates for
-* real_drawable
-</parameter_description>
-</parameter>
-<parameter name="y_offset">
-<parameter_description> location to store the Y offset between coordinates in @window,
-and the underlying window system primitive coordinates for
-* real_drawable
+<parameter name="manager">
+<parameter_description> a #GdkDisplayManager
</parameter_description>
</parameter>
</parameters>
-<return></return>
-</function>
-
-<function name="gdk_gc_set_foreground">
-<description>
-Sets the foreground color for a graphics context.
-Note that this function uses @color->pixel, use
-gdk_gc_set_rgb_fg_color() to specify the foreground
-color as red, green, blue components.
+<return> a newly
+allocated #GSList of #GdkDisplay objects. Free with g_slist_free()
+when you are done with it.
-</description>
-<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
-</parameter_description>
-</parameter>
-<parameter name="color">
-<parameter_description> the new foreground color.
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
+</return>
</function>
-<function name="gdk_event_get_time">
+<function name="gdk_display_manager_open_display">
<description>
-Returns the time stamp from @event, if there is one; otherwise
-returns #GDK_CURRENT_TIME. If @event is %NULL, returns #GDK_CURRENT_TIME.
+Opens a display.
+Since: 3.0
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #GdkEvent
+<parameter name="manager">
+<parameter_description> a #GdkDisplayManager
</parameter_description>
</parameter>
-</parameters>
-<return> time stamp field from @event
-</return>
-</function>
-
-<function name="gdk_color_hash">
-<description>
-A hash function suitable for using for a hash
-table that stores #GdkColor's.
-
-
-</description>
-<parameters>
-<parameter name="colora">
-<parameter_description> a #GdkColor.
+<parameter name="name">
+<parameter_description> the name of the display to open
</parameter_description>
</parameter>
</parameters>
-<return> The hash function applied to @colora
+<return> a #GdkDisplay, or %NULL
+if the display could not be opened
+
</return>
</function>
-<function name="gdk_event_set_screen">
+<function name="gdk_display_manager_set_default_display">
<description>
-Sets the screen for @event to @screen. The event must
-have been allocated by GTK+, for instance, by
-gdk_event_copy().
+Sets @display as the default display.
Since: 2.2
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #GdkEvent
+<parameter name="manager">
+<parameter_description> a #GdkDisplayManager
</parameter_description>
</parameter>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_event_get_axis">
+<function name="gdk_display_notify_startup_complete">
<description>
-Extract the axis value for a particular axis use from
-an event structure.
+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="event">
-<parameter_description> a #GdkEvent
-</parameter_description>
-</parameter>
-<parameter name="axis_use">
-<parameter_description> the axis use to look for
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> location to store the value found
+<parameter name="startup_id">
+<parameter_description> a startup-notification identifier, for which
+notification process should be completed
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the specified axis was found, otherwise %FALSE
-</return>
+<return></return>
</function>
-<function name="gdk_screen_get_monitor_geometry">
+<function name="gdk_display_open">
<description>
-Retrieves the #GdkRectangle representing the size and position of
-the individual monitor within the entire screen area.
-
-Note that the size of the entire screen area can be retrieved via
-gdk_screen_get_width() and gdk_screen_get_height().
+Opens a display.
Since: 2.2
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
-</parameter_description>
-</parameter>
-<parameter name="monitor_num">
-<parameter_description> the monitor number, between 0 and gdk_screen_get_n_monitors (screen)
-</parameter_description>
-</parameter>
-<parameter name="dest">
-<parameter_description> a #GdkRectangle to be filled with the monitor geometry
+<parameter name="display_name">
+<parameter_description> the name of the display to open
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GdkDisplay, or %NULL
+if the display could not be opened
+
+</return>
</function>
-<function name="gdk_pango_context_get">
+<function name="gdk_display_open_default_libgtk_only">
<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.
+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> a new #PangoContext for the default display
+<return> the default display, if it could be
+opened, otherwise %NULL.
</return>
</function>
-<function name="gdk_color_black">
+<function name="gdk_display_peek_event">
<description>
-Returns the black color for a given colormap. The resulting
-value has already been allocated.
+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="colormap">
-<parameter_description> a #GdkColormap.
-</parameter_description>
-</parameter>
-<parameter name="color">
-<parameter_description> the location to store the color.
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the allocation succeeded.
+<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_window_get_toplevel">
+<function name="gdk_display_pointer_is_grabbed">
<description>
-Gets the toplevel window that's an ancestor of @window.
+Test if the pointer is grabbed.
-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.
+Since: 2.2
+Deprecated: 3.0: Use gdk_display_device_is_grabbed() instead.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return> the toplevel window containing @window
+<return> %TRUE if an active X pointer grab is in effect
+
</return>
</function>
-<function name="gdk_window_clear_area_e">
+<function name="gdk_display_pointer_ungrab">
<description>
-Like gdk_window_clear_area(), but also generates an expose event for
-the cleared area.
+Release any pointer grab.
-This function has a stupid name because it dates back to the mists
-time, pre-GDK-1.0.
+Since: 2.2
+Deprecated: 3.0: Use gdk_device_ungrab(), together with gdk_device_grab()
+instead.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> x coordinate of rectangle to clear
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> y coordinate of rectangle to clear
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> width of rectangle to clear
+<parameter name="display">
+<parameter_description> a #GdkDisplay.
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> height of rectangle to clear
+<parameter name="time_">
+<parameter_description> a timestap (e.g. %GDK_CURRENT_TIME).
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_display_warp_pointer">
+<function name="gdk_display_put_event">
<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.
+Appends a copy of the given event onto the front of the event
+queue for @display.
-Since: 2.8
+Since: 2.2
</description>
<parameters>
@@ -2678,362 +2356,276 @@ Since: 2.8
<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 name="event">
+<parameter_description> a #GdkEvent.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_gc_offset">
+<function name="gdk_display_request_selection_notification">
<description>
-Offset attributes such as the clip and tile-stipple origins
-of the GC so that drawing at x - x_offset, y - y_offset with
-the offset GC has the same effect as drawing at x, y with the original
-GC.
+Request #GdkEventOwnerChange events for ownership changes
+of the selection named by the given atom.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC
-</parameter_description>
-</parameter>
-<parameter name="x_offset">
-<parameter_description> amount by which to offset the GC in the X direction
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="y_offset">
-<parameter_description> amount by which to offset the GC in the Y direction
+<parameter name="selection">
+<parameter_description> the #GdkAtom naming the selection for which
+ownership change notification is requested
</parameter_description>
</parameter>
</parameters>
-<return></return>
-</function>
-
-<function name="gdk_image_get">
-<description>
-This is a deprecated wrapper for gdk_drawable_get_image();
-gdk_drawable_get_image() should be used instead. Or even better: in
-most cases gdk_pixbuf_get_from_drawable() is the most convenient
-choice.
-
+<return> whether #GdkEventOwnerChange events will
+be sent.
-</description>
-<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
-</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="width">
-<parameter_description> width of area in @window
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> height of area in @window
-</parameter_description>
-</parameter>
-</parameters>
-<return> a new #GdkImage or %NULL
</return>
</function>
-<function name="gdk_font_id">
+<function name="gdk_display_set_double_click_distance">
<description>
-Returns the X Font ID for the given font.
+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 <emphasis>not</emphasis> set this, it is a global
+user-configured setting.
+Since: 2.4
</description>
<parameters>
-<parameter name="font">
-<parameter_description> a #GdkFont.
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-</parameters>
-<return> the numeric X Font ID
-</return>
-</function>
-
-<function name="gdk_window_lookup">
-<description>
-Looks up the #GdkWindow that wraps the given native window handle.
-
-For example in the X backend, a native window handle is an Xlib
-<type>XID</type>.
-
-
-</description>
-<parameters>
-<parameter name="anid">
-<parameter_description> a native window handle.
+<parameter name="distance">
+<parameter_description> distance in pixels
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkWindow wrapper for the native window,
-or %NULL if there is none.
-</return>
+<return></return>
</function>
-<function name="gdk_region_intersect">
+<function name="gdk_display_set_double_click_time">
<description>
-Sets the area of @source1 to the intersection of the areas of @source1
-and @source2. The resulting area is the set of pixels contained in
-both @source1 and @source2.
+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 <emphasis>not</emphasis> set this, it is a global
+user-configured setting.
+
+Since: 2.2
</description>
<parameters>
-<parameter name="source1">
-<parameter_description> a #GdkRegion
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="source2">
-<parameter_description> another #GdkRegion
+<parameter name="msec">
+<parameter_description> double click time in milliseconds (thousandths of a second)
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_text_property_to_utf8_list_for_display">
+<function name="gdk_display_store_clipboard">
<description>
-Converts a text property in the given encoding to
-a list of UTF-8 strings.
+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
+<ulink url="http://www.freedesktop.org/Standards/clipboard-manager-spec">
+http://www.freedesktop.org/Standards/clipboard-manager-spec</ulink>.
-Since: 2.2
+Since: 2.6
</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> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="format">
-<parameter_description> the format of the property
+<parameter name="clipboard_window">
+<parameter_description> a #GdkWindow belonging to the clipboard owner
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> the text to convert
+<parameter name="time_">
+<parameter_description> a timestamp
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> the length of @text, in bytes
+<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="list">
-<parameter_description> location to store the list of strings or %NULL. The
-list should be freed with g_strfreev().
+<parameter name="n_targets">
+<parameter_description> length of the @targets array
</parameter_description>
</parameter>
</parameters>
-<return> the number of strings in the resulting
-list.
-
-</return>
+<return></return>
</function>
-<function name="gdk_window_set_events">
+<function name="gdk_display_supports_clipboard_persistence">
<description>
-The event mask for a window determines which events will be reported
-for that 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.
+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="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="event_mask">
-<parameter_description> event mask for @window
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the display supports clipboard persistance.
+
+</return>
</function>
-<function name="gdk_window_set_keep_above">
+<function name="gdk_display_supports_composite">
<description>
-Set if @window must be kept above other windows. If the
-window was already above, then this function does nothing.
+Returns %TRUE if gdk_window_set_composited() can be used
+to redirect drawing on the window using compositing.
-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
-"keep above"; 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.
+Currently this only works on X11 with XComposite and
+XDamage extensions available.
-Since: 2.4
+Since: 2.12
</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 name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if windows may be composited.
+
+</return>
</function>
-<function name="gdk_window_set_debug_updates">
+<function name="gdk_display_supports_cursor_alpha">
<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.
+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="setting">
-<parameter_description> %TRUE to turn on update debugging
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether cursors can have alpha channels.
+
+</return>
</function>
-<function name="gdk_drag_context_ref">
+<function name="gdk_display_supports_cursor_color">
<description>
-Deprecated function; use g_object_ref() instead.
+Returns %TRUE if multicolored cursors are supported
+on @display. Otherwise, cursors have only a forground
+and a background color.
-Deprecated: 2.2: Use g_object_ref() instead.
+Since: 2.4
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GdkDragContext.
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</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.
-
+<return> whether cursors can have multiple colors.
-</description>
-<parameters>
-</parameters>
-<return> the default root window
</return>
</function>
-<function name="gdk_string_height">
+<function name="gdk_display_supports_input_shapes">
<description>
-Determines the total height of a given nul-terminated
-string. This value is not generally useful, because you
-cannot determine how this total height will be drawn in
-relation to the baseline. See gdk_string_extents().
+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="font">
-<parameter_description> a #GdkFont
-</parameter_description>
-</parameter>
-<parameter name="string">
-<parameter_description> the nul-terminated string to measure.
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return> the height of the string in pixels.
+<return> %TRUE if windows with modified input shape are supported
+
</return>
</function>
-<function name="gdk_query_visual_types">
+<function name="gdk_display_supports_selection_notification">
<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.
+Returns whether #GdkEventOwnerChange events will be
+sent when the owner of a selection changes.
-The array returned by this function should not be freed.
+Since: 2.6
</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 name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether #GdkEventOwnerChange events will
+be sent.
+
+</return>
</function>
-<function name="gdk_screen_get_monitor_height_mm">
+<function name="gdk_display_supports_shapes">
<description>
-Gets the height in millimeters of the specified monitor.
+Returns %TRUE if gdk_window_shape_combine_mask() can
+be used to create shaped windows on @display.
-Since: 2.14
+Since: 2.10
</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 name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return> the height of the monitor, or -1 if not available
+<return> %TRUE if shaped windows are supported
</return>
</function>
-<function name="gdk_display_close">
+<function name="gdk_display_sync">
<description>
-Closes the connection to the windowing system for the given display,
-and cleans up associated resources.
+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
@@ -3047,2386 +2639,2033 @@ Since: 2.2
<return></return>
</function>
-<function name="gdk_query_depths">
+<function name="gdk_display_warp_pointer">
<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.
+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.
-The array returned by this function should not be freed.
+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="depths">
-<parameter_description> return location for available depths
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="count">
-<parameter_description> return location for number of available depths
+<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_char_measure">
+<function name="gdk_drag_abort">
<description>
-Determines the distance from the origin to the rightmost
-portion of a character when drawn. This is not the
-correct value for determining the origin of the next
-portion when drawing text in multiple pieces.
+Aborts a drag without dropping.
+This function is called by the drag source.
</description>
<parameters>
-<parameter name="font">
-<parameter_description> a #GdkFont
+<parameter name="context">
+<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
-<parameter name="character">
-<parameter_description> the character to measure.
+<parameter name="time_">
+<parameter_description> the timestamp for this operation
</parameter_description>
</parameter>
</parameters>
-<return> the right bearing of the character in pixels.
-</return>
+<return></return>
</function>
-<function name="gdk_spawn_on_screen">
+<function name="gdk_drag_begin">
<description>
-Like g_spawn_async(), except the child process is spawned in such
-an environment that on calling gdk_display_open() it would be
-returned a #GdkDisplay with @screen as the default screen.
+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 is useful for applications which wish to launch an application
-on a specific screen.
+This function is called by the drag source.
-Since: 2.4
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
-</parameter_description>
-</parameter>
-<parameter name="working_directory">
-<parameter_description> child's current working directory, or %NULL to
-inherit parent's
-</parameter_description>
-</parameter>
-<parameter name="argv">
-<parameter_description> child's argument vector
-</parameter_description>
-</parameter>
-<parameter name="envp">
-<parameter_description> child's environment, or %NULL to inherit parent's
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> flags from #GSpawnFlags
+<parameter name="window">
+<parameter_description> the source window for this drag.
</parameter_description>
</parameter>
-<parameter name="child_setup">
-<parameter_description> function to run in the child just before exec()
+<parameter name="targets">
+<parameter_description> the offered targets,
+as list of #GdkAtoms
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data for @child_setup
+</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="child_pid">
-<parameter_description> return location for child process ID, or %NULL
+<parameter name="device">
+<parameter_description> the device that controls this drag
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for error
+<parameter name="targets">
+<parameter_description> the offered targets,
+as list of #GdkAtoms
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success, %FALSE if error is set
-
+<return> a newly created #GdkDragContext
</return>
</function>
-<function name="gdk_keymap_map_virtual_modifiers">
+<function name="gdk_drag_context_get_actions">
<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.
+Determines the bitmask of actions proposed by the source if
+gdk_drag_context_get_suggested_action() returns GDK_ACTION_ASK.
-Since: 2.20
+Since: 2.22
</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 name="context">
+<parameter_description> a #GdkDragContext
</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> the #GdkDragAction flags
</return>
</function>
-<function name="gdk_color_to_string">
+<function name="gdk_drag_context_get_dest_window">
<description>
-Returns a textual specification of @color in the hexadecimal form
-<literal>rrrrggggbbbb</literal>, where <literal>r</literal>,
-<literal>g</literal> and <literal>b</literal> are hex digits
-representing the red, green and blue components respectively.
+Returns the destination windw for the DND operation.
-Since: 2.12
+Since: 3.0
</description>
<parameters>
-<parameter name="color">
-<parameter_description> a #GdkColor
+<parameter name="context">
+<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated text string
+<return> a #GdkWindow
</return>
</function>
-<function name="gdk_pixmap_foreign_new_for_screen">
+<function name="gdk_drag_context_get_device">
<description>
-Wraps a native pixmap in a #GdkPixmap.
-This may fail if the pixmap has been destroyed.
+Returns the #GdkDevice associated to the drag context.
-For example in the X backend, a native pixmap handle is an Xlib
-<type>XID</type>.
-
-This function is an alternative to gdk_pixmap_foreign_new_for_display()
-for cases where the dimensions of the pixmap are known. For the X
-backend, this avoids a roundtrip to the server.
-
-Since: 2.10
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
-</parameter_description>
-</parameter>
-<parameter name="anid">
-<parameter_description> a native pixmap handle
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> the width of the pixmap identified by @anid
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> the height of the pixmap identified by @anid
-</parameter_description>
-</parameter>
-<parameter name="depth">
-<parameter_description> the depth of the pixmap identified by @anid
+<parameter name="context">
+<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
</parameters>
-<return> the newly-created #GdkPixmap wrapper for the
-native pixmap or %NULL if the pixmap has been destroyed.
-
+<return> The #GdkDevice associated to @context.
</return>
</function>
-<function name="gdk_set_sm_client_id">
+<function name="gdk_drag_context_get_protocol">
<description>
-Sets the <literal>SM_CLIENT_ID</literal> 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.
+Returns the drag protocol thats used by this context.
-See the X Session Management Library documentation for more information on
-session management and the Inter-Client Communication Conventions Manual
-(ICCCM) for information on the <literal>WM_CLIENT_LEADER</literal> property.
-(Both documents are part of the X Window System distribution.)
+Since: 3.0
</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 name="context">
+<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the drag protocol
+
+</return>
</function>
-<function name="gdk_window_unstick">
+<function name="gdk_drag_context_get_selected_action">
<description>
-Reverse operation for gdk_window_stick(); see gdk_window_stick(),
-and gtk_window_unstick().
+Determines the action chosen by the drag destination.
+Since: 2.22
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="context">
+<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GdkDragAction value
+
+</return>
</function>
-<function name="gdk_selection_property_get">
+<function name="gdk_drag_context_get_source_window">
<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.
+Returns the #GdkWindow where the DND operation started.
+Since: 2.22
</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 name="context">
+<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
</parameters>
-<return> the length of the retrieved data.
+<return> a #GdkWindow
+
</return>
</function>
-<function name="gdk_visual_get_system">
+<function name="gdk_drag_context_get_suggested_action">
<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.
+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> system visual
+<return> a #GdkDragAction value
+
</return>
</function>
-<function name="gdk_x11_xatom_to_atom">
+<function name="gdk_drag_context_list_targets">
<description>
-Convert from an X atom for the default display to the corresponding
-#GdkAtom.
+Retrieves the list of targets of the context.
+Since: 2.22
</description>
<parameters>
-<parameter name="xatom">
-<parameter_description> an X atom for the default GDK display
+<parameter name="context">
+<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
</parameters>
-<return> the corresponding G#dkAtom.
+<return> a #GList of targets
+
</return>
</function>
-<function name="gdk_window_invalidate_rect">
+<function name="gdk_drag_context_set_device">
<description>
-A convenience wrapper around gdk_window_invalidate_region() which
-invalidates a rectangular region. See
-gdk_window_invalidate_region() for details.
+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="window">
-<parameter_description> a #GdkWindow
+<parameter name="context">
+<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
-<parameter name="rect">
-<parameter_description> rectangle to invalidate or %NULL to invalidate the whole
-window
+<parameter name="device">
+<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
-<parameter name="invalidate_children">
-<parameter_description> whether to also invalidate child windows
+</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_drawable_get_screen">
+<function name="gdk_drag_drop_succeeded">
<description>
-Gets the #GdkScreen associated with a #GdkDrawable.
+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.2
+Since: 2.6
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<parameter name="context">
+<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkScreen associated with @drawable
+<return> %TRUE if the drop was successful.
</return>
</function>
-<function name="gdk_draw_text">
+<function name="gdk_drag_find_window_for_screen">
<description>
-Draws a number of characters in the given font or fontset.
+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().
-Deprecated: 2.4: Use gdk_draw_layout() instead.
+Since: 2.2
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
+<parameter name="context">
+<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
-<parameter name="font">
-<parameter_description> a #GdkFont.
+<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="gc">
-<parameter_description> a #GdkGC.
+<parameter name="screen">
+<parameter_description> the screen where the destination window is sought
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> the x coordinate of the left edge of the text.
+<parameter name="x_root">
+<parameter_description> the x position of the pointer in root coordinates
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the y coordinate of the baseline of the text.
+<parameter name="y_root">
+<parameter_description> the y position of the pointer in root coordinates
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> the characters to draw.
+<parameter name="dest_window">
+<parameter_description> location to store the destination window in
</parameter_description>
</parameter>
-<parameter name="text_length">
-<parameter_description> the number of characters of @text to draw.
+<parameter name="protocol">
+<parameter_description> location to store the DND protocol in
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_keymap_add_virtual_modifiers">
+<function name="gdk_drag_get_selection">
<description>
-Adds virtual modifiers (i.e. Super, Hyper and Meta) which correspond
-to the real modifiers (i.e Mod2, Mod3, ...) in @modifiers.
-are set in @state to their non-virtual counterparts (i.e. Mod2,
-Mod3,...) and set the corresponding bits in @state.
+Returns the selection atom for the current source window.
-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 name="context">
+<parameter_description> a #GdkDragContext.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the selection atom, or %GDK_NONE
+</return>
</function>
-<function name="gdk_x11_font_get_name">
+<function name="gdk_drag_motion">
<description>
-Return the X Logical Font Description (for font->type == GDK_FONT_FONT)
-or comma separated list of XLFDs (for font->type == GDK_FONT_FONTSET)
-that was used to load the font. If the same font was loaded
-via multiple names, which name is returned is undefined.
+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="font">
-<parameter_description> a #GdkFont.
+<parameter name="context">
+<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
-</parameters>
-<return> the name of the font. This string is owned
-by GDK and must not be modified or freed.
-</return>
-</function>
-
-<function name="gdk_drawable_set_colormap">
-<description>
-Sets the colormap associated with @drawable. Normally this will
-happen automatically when the drawable is created; you only need to
-use this function if the drawable-creating function did not have a
-way to determine the colormap, and you then use drawable operations
-that require a colormap. The colormap for all drawables and
-graphics contexts you intend to use together should match. i.e.
-when using a #GdkGC to draw to a drawable, or copying one drawable
-to another, the colormaps should match.
-
-
-</description>
-<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<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="colormap">
-<parameter_description> a #GdkColormap
+<parameter name="time_">
+<parameter_description> the timestamp for this operation
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_pixmap_colormap_create_from_xpm_d">
+<function name="gdk_drag_status">
<description>
-Create a pixmap from data in XPM format using a particular
-colormap.
+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="drawable">
-<parameter_description> a #GdkDrawable, used to determine default values
-for the new pixmap. Can be %NULL if @colormap is given.
-</parameter_description>
-</parameter>
-<parameter name="colormap">
-<parameter_description> the #GdkColormap that the new pixmap will be use.
-If omitted, the colormap for @window will be used.
-</parameter_description>
-</parameter>
-<parameter name="mask">
-<parameter_description> a pointer to a place to store a bitmap representing
-the transparency mask of the XPM file. Can be %NULL,
-in which case transparency will be ignored.
+<parameter name="context">
+<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
-<parameter name="transparent_color">
-<parameter_description> the color to be used for the pixels
-that are transparent in the input file. Can be %NULL,
-in which case a default color will be used.
+<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="data">
-<parameter_description> Pointer to a string containing the XPM data.
+<parameter name="time_">
+<parameter_description> the timestamp for this operation
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkPixmap.
-</return>
+<return></return>
</function>
-<function name="gdk_region_offset">
+<function name="gdk_drop_finish">
<description>
-Moves a region the specified distance.
+Ends the drag operation after a drop.
+
+This function is called by the drag destination.
</description>
<parameters>
-<parameter name="region">
-<parameter_description> a #GdkRegion
+<parameter name="context">
+<parameter_description> a #GtkDragContext
</parameter_description>
</parameter>
-<parameter name="dx">
-<parameter_description> the distance to move the region horizontally
+<parameter name="success">
+<parameter_description> %TRUE if the data was successfully received
</parameter_description>
</parameter>
-<parameter name="dy">
-<parameter_description> the distance to move the region vertically
+<parameter name="time_">
+<parameter_description> the timestamp for this operation
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_clear_area">
+<function name="gdk_drop_reply">
<description>
-Clears an area of @window to the background color or background pixmap.
+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="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> x coordinate of rectangle to clear
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> y coordinate of rectangle to clear
+<parameter name="context">
+<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> width of rectangle to clear
+<parameter name="accepted">
+<parameter_description> %TRUE if the drop is accepted
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> height of rectangle to clear
+<parameter name="time_">
+<parameter_description> the timestamp for this operation
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_get_parent">
+<function name="gdk_error_trap_pop">
<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.
+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>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
</parameters>
-<return> parent of @window
+<return> X error code or 0 on success
</return>
</function>
-<function name="gdk_display_request_selection_notification">
+<function name="gdk_error_trap_pop_ignored">
<description>
-Request #GdkEventOwnerChange events for ownership changes
-of the selection named by the given atom.
+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: 2.6
+Since: 3.0
</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>
+<return></return>
</function>
-<function name="gdk_set_pointer_hooks">
+<function name="gdk_error_trap_push">
<description>
-This function allows for hooking into the operation
-of getting the current location of the pointer. This
-is only useful for such low-level tools as an
-event recorder. Applications should never have any
-reason to use this facility.
+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.
+
+<example>
+<title>Trapping an X error</title>
+<programlisting>
+gdk_error_trap_push (<!-- -->);
+
+// ... Call the X function which may cause an error here ...
+
+
+if (gdk_error_trap_pop (<!-- -->))
+{
+// ... Handle the error here ...
+}
+</programlisting>
+</example>
+
+</description>
+<parameters>
+</parameters>
+<return></return>
+</function>
-This function is not multihead safe. For multihead operation,
-see gdk_display_set_pointer_hooks().
+<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="new_hooks">
-<parameter_description> a table of pointers to functions for getting
-quantities related to the current pointer position,
-or %NULL to restore the default table.
+<parameter name="event">
+<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
</parameters>
-<return> the previous pointer hook table
+<return> a copy of @event. The returned #GdkEvent should be freed with
+gdk_event_free().
</return>
</function>
-<function name="gdk_display_sync">
+<function name="gdk_event_free">
<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
+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="display">
-<parameter_description> a #GdkDisplay
+<parameter name="event">
+<parameter_description> a #GdkEvent.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_get_geometry">
+<function name="gdk_event_get">
<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.
+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().
-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.
+</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.
-<note>
-If @window is not a toplevel, it is <emphasis>much</emphasis> better
-to call gdk_window_get_position() and gdk_drawable_get_size() instead,
-because it avoids the roundtrip to the X server and because
-gdk_drawable_get_size() supports the full 32-bit coordinate space,
-whereas gdk_window_get_geometry() is restricted to the 16-bit
-coordinates of X11.
-</note>
</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 name="event">
+<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> return location for height of window
+<parameter name="axis_use">
+<parameter_description> the axis use to look for
</parameter_description>
</parameter>
-<parameter name="depth">
-<parameter_description> return location for bit depth of window
+<parameter name="value">
+<parameter_description> location to store the value found
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the specified axis was found, otherwise %FALSE
+</return>
</function>
-<function name="gdk_pango_attr_stipple_new">
+<function name="gdk_event_get_button">
<description>
-Creates a new attribute containing a stipple bitmap to be used when
-rendering the text.
+Extract the button number from an event.
+Since: 3.2
</description>
<parameters>
-<parameter name="stipple">
-<parameter_description> a bitmap to be set as stipple
+<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> new #PangoAttribute
+<return> %TRUE if the event delivered a button number
+
</return>
</function>
-<function name="gdk_window_raise">
+<function name="gdk_event_get_click_count">
<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.
+Extracts the click count from an event.
-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.
+Since: 3.2
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<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></return>
+<return> %TRUE if the event delivered a click count
+
+</return>
</function>
-<function name="gdk_window_set_hints">
+<function name="gdk_event_get_coords">
<description>
-This function is broken and useless and you should ignore it.
-If using GTK+, use functions such as gtk_window_resize(), gtk_window_set_size_request(),
-gtk_window_move(), gtk_window_parse_geometry(), and gtk_window_set_geometry_hints(),
-depending on what you're trying to do.
-
-If using GDK directly, use gdk_window_set_geometry_hints().
+Extract the event window relative x/y coordinates from an event.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="event">
+<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> ignored field, does not matter
+<parameter name="x_win">
+<parameter_description> location to put event window x coordinate
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> ignored field, does not matter
-</parameter_description>
-</parameter>
-<parameter name="min_width">
-<parameter_description> minimum width hint
-</parameter_description>
-</parameter>
-<parameter name="min_height">
-<parameter_description> minimum height hint
-</parameter_description>
-</parameter>
-<parameter name="max_width">
-<parameter_description> max width hint
-</parameter_description>
-</parameter>
-<parameter name="max_height">
-<parameter_description> max height hint
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> logical OR of GDK_HINT_POS, GDK_HINT_MIN_SIZE, and/or GDK_HINT_MAX_SIZE
+<parameter name="y_win">
+<parameter_description> location to put event window y coordinate
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the event delivered event window coordinates
+</return>
</function>
-<function name="gdk_threads_add_timeout_seconds">
+<function name="gdk_event_get_device">
<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().
+If the event contains a "device" field, this function will return
+it, else it will return %NULL.
-Since: 2.14
+Since: 3.0
</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 name="event">
+<parameter_description> a #GdkEvent.
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
+<return> a #GdkDevice, or %NULL.
</return>
</function>
-<function name="gdk_window_lower">
+<function name="gdk_event_get_keycode">
<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.
+Extracts the hardware keycode from an event.
-Note that gdk_window_show() raises the window again, so don't call this
-function before gdk_window_show(). (Try gdk_window_show_unraised().)
+Since: 3.2
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<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></return>
-</function>
-
-<function name="gdk_keymap_get_default">
-<description>
-Returns the #GdkKeymap attached to the default display.
+<return> %TRUE if the event delivered a hardware keycode
-</description>
-<parameters>
-</parameters>
-<return> the #GdkKeymap attached to the default display.
</return>
</function>
-<function name="gdk_screen_broadcast_client_message">
+<function name="gdk_event_get_keyval">
<description>
-On X11, sends an X ClientMessage event to all toplevel windows on
- screen
-
-Toplevel windows are determined by checking for the WM_STATE property,
-as described in the Inter-Client Communication Conventions Manual (ICCCM).
-If no windows are found with the WM_STATE property set, the message is
-sent to all children of the root window.
+Extracts the keyval from an event.
-On Windows, broadcasts a message registered with the name
-GDK_WIN32_CLIENT_MESSAGE to all top-level windows. The amount of
-data is limited to one long, i.e. four bytes.
-
-Since: 2.2
+Since: 3.2
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> the #GdkScreen where the event will be broadcasted.
+<parameter name="event">
+<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
-<parameter name="event">
-<parameter_description> the #GdkEvent.
+<parameter name="keyval">
+<parameter_description> location to store the keyval
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the event delivered a key symbol
+
+</return>
</function>
-<function name="gdk_window_set_icon_list">
+<function name="gdk_event_get_root_coords">
<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.
+Extract the root window relative x/y coordinates from an event.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> The #GdkWindow toplevel window to set the icon of.
+<parameter name="event">
+<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
-<parameter name="pixbufs">
-<parameter_description> A list of pixbufs, of different sizes.
+<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></return>
+<return> %TRUE if the event delivered root window coordinates
+</return>
</function>
-<function name="gdk_gc_get_screen">
+<function name="gdk_event_get_screen">
<description>
-Gets the #GdkScreen for which @gc was created
+Returns the screen for the event. The screen is
+typically the screen for <literal>event->any.window</literal>, 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 <literal>event->motion.x_root</literal> and
+<literal>event->motion.y_root</literal> are relative.
Since: 2.2
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
+<parameter name="event">
+<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkScreen for @gc.
+<return> the screen for the event
</return>
</function>
-<function name="gdk_cursor_new_from_pixbuf">
+<function name="gdk_event_get_scroll_direction">
<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.
-
-On the X backend, support for RGBA cursors requires a
-sufficently new version of the X Render extension.
+Extracts the scroll direction from an event.
-Since: 2.4
+Since: 3.2
</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 name="event">
+<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the vertical offset of the 'hotspot' of the cursor.
+<parameter name="direction">
+<parameter_description> location to store the scroll direction
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkCursor.
+<return> %TRUE if the event delivered a scroll direction
</return>
</function>
-<function name="gdk_test_render_sync">
+<function name="gdk_event_get_source_device">
<description>
-This function retrives a pixel from @window to force the windowing
-system to carry out any pending rendering commands.
-This function is intended to be used to syncronize with rendering
-pipelines, to benchmark windowing system rendering operations.
-
-</description>
-<parameters>
-<parameter name="window">
-<parameter_description> a mapped GdkWindow
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
+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.
-<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.
+If the event does not contain a device field, this function will
+return %NULL.
+Since: 3.0
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> user data
+<parameter name="event">
+<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GdkDevice, or %NULL.
+
+</return>
</function>
-<function name="gdk_window_get_decorations">
+<function name="gdk_event_get_state">
<description>
-Returns the decorations set on the GdkWindow with #gdk_window_set_decorations
+If the event contains a "state" 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="window">
-<parameter_description> The toplevel #GdkWindow to get the decorations from
+<parameter name="event">
+<parameter_description> a #GdkEvent or NULL
</parameter_description>
</parameter>
-<parameter name="decorations">
-<parameter_description> The window decorations will be written here
+<parameter name="state">
+<parameter_description> return location for state
</parameter_description>
</parameter>
</parameters>
-<return> TRUE if the window has decorations set, FALSE otherwise.
+<return> %TRUE if there was a state field in the event
</return>
</function>
-<function name="gdk_keymap_have_bidi_layouts">
+<function name="gdk_event_get_time">
<description>
-Determines if keyboard layouts for both right-to-left and left-to-right
-languages are in use.
+Returns the time stamp from @event, if there is one; otherwise
+returns #GDK_CURRENT_TIME. If @event is %NULL, returns #GDK_CURRENT_TIME.
-Since: 2.12
</description>
<parameters>
-<parameter name="keymap">
-<parameter_description> a #GdkKeymap or %NULL to use the default keymap
+<parameter name="event">
+<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if there are layouts in both directions, %FALSE otherwise
-
+<return> time stamp field from @event
</return>
</function>
-<function name="gdk_pointer_grab_info_libgtk_only">
+<function name="gdk_event_handler_set">
<description>
-Determines information about the current pointer grab.
-This is not public API and must not be used by applications.
+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="display">
-<parameter_description> the #GdkDisplay for which to get the grab information
+<parameter name="func">
+<parameter_description> the function to call to handle events from GDK.
</parameter_description>
</parameter>
-<parameter name="grab_window">
-<parameter_description> location to store current grab window
+<parameter name="data">
+<parameter_description> user data to pass to the function.
</parameter_description>
</parameter>
-<parameter name="owner_events">
-<parameter_description> location to store boolean indicating whether
-the @owner_events flag to gdk_pointer_grab() was %TRUE.
+<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> %TRUE if this application currently has the
-pointer grabbed.
-</return>
+<return></return>
</function>
-<function name="gdk_draw_line">
+<function name="gdk_event_new">
<description>
-Draws a line, using the foreground color and other attributes of
-the #GdkGC.
+Creates a new event of the given type. All fields are set to 0.
+
+Since: 2.2
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
-</parameter_description>
-</parameter>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
-</parameter_description>
-</parameter>
-<parameter name="x1_">
-<parameter_description> the x coordinate of the start point.
-</parameter_description>
-</parameter>
-<parameter name="y1_">
-<parameter_description> the y coordinate of the start point.
-</parameter_description>
-</parameter>
-<parameter name="x2_">
-<parameter_description> the x coordinate of the end point.
-</parameter_description>
-</parameter>
-<parameter name="y2_">
-<parameter_description> the y coordinate of the end point.
+<parameter name="type">
+<parameter_description> a #GdkEventType
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a newly-allocated #GdkEvent. The returned #GdkEvent
+should be freed with gdk_event_free().
+
+</return>
</function>
-<function name="gdk_drag_drop">
+<function name="gdk_event_peek">
<description>
-Drops on the current destination.
+If there is an event waiting in the event queue of some open
+display, returns a copy of it. See gdk_display_peek_event().
-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>
+<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_drawable_set_data">
+<function name="gdk_event_put">
<description>
-This function is equivalent to g_object_set_data(),
-the #GObject variant should be used instead.
-
+Appends a copy of the given event onto the front of the event
+queue for event->any.window's display, or the default event
+queue if event->any.window is %NULL. See gdk_display_put_event().
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> name to store the data under
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> arbitrary data
-</parameter_description>
-</parameter>
-<parameter name="destroy_func">
-<parameter_description> function to free @data, or %NULL
+<parameter name="event">
+<parameter_description> a #GdkEvent.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_event_get_screen">
+<function name="gdk_event_request_motions">
<description>
-Returns the screen for the event. The screen is
-typically the screen for <literal>event->any.window</literal>, 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 <literal>event->motion.x_root</literal> and
-<literal>event->motion.y_root</literal> are relative.
+Request more motion notifies if @event is a motion notify hint event.
-Since: 2.2
+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->x;
+y = motion_event->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 #GdkEvent
+<parameter_description> a valid #GdkEvent
</parameter_description>
</parameter>
</parameters>
-<return> the screen for the event
-
-</return>
+<return></return>
</function>
-<function name="gdk_pixbuf_render_pixmap_and_mask">
+<function name="gdk_event_set_device">
<description>
-Creates a pixmap and a mask bitmap which are returned in the @pixmap_return
-and @mask_return arguments, respectively, and renders a pixbuf and its
-corresponding thresholded alpha mask to them. This is merely a convenience
-function; applications that need to render pixbufs with dither offsets or to
-given drawables should use gdk_draw_pixbuf() and gdk_pixbuf_render_threshold_alpha().
-
-The pixmap that is created is created for the colormap returned
-by gdk_rgb_get_colormap(). You normally will want to instead use
-the actual colormap for a widget, and use
-gdk_pixbuf_render_pixmap_and_mask_for_colormap().
+Sets the device for @event to @device. The event must
+have been allocated by GTK+, for instance, by
+gdk_event_copy().
-If the pixbuf does not have an alpha channel, then * mask_return will be set
-to %NULL.
+Since: 3.0
</description>
<parameters>
-<parameter name="pixbuf">
-<parameter_description> A pixbuf.
-</parameter_description>
-</parameter>
-<parameter name="pixmap_return">
-<parameter_description> Location to store a pointer to the created pixmap,
-or %NULL if the pixmap is not needed.
-</parameter_description>
-</parameter>
-<parameter name="mask_return">
-<parameter_description> Location to store a pointer to the created mask,
-or %NULL if the mask is not needed.
+<parameter name="event">
+<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
-<parameter name="alpha_threshold">
-<parameter_description> Threshold value for opacity values.
+<parameter name="device">
+<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_display_manager_list_displays">
+<function name="gdk_event_set_screen">
<description>
-List all currently open displays.
+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="display_manager">
-<parameter_description> a #GdkDisplayManager
+<parameter name="event">
+<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
-</parameters>
-<return> a newly allocated #GSList of #GdkDisplay objects.
-Free this list with g_slist_free() when you are done with it.
-
-</return>
-</function>
-
-<function name="gdk_xid_table_lookup">
-<description>
-Returns the Gdk object associated with the given X id for the default
-display.
-
-
-</description>
-<parameters>
-<parameter name="xid">
-<parameter_description> an X id.
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return> the associated Gdk object, which may be a #GdkPixmap,
-a #GdkWindow or a #GdkFont or %NULL if no object is associated
-with the X id.
-</return>
+<return></return>
</function>
-<function name="gdk_window_merge_child_input_shapes">
+<function name="gdk_event_set_source_device">
<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_mask().
+Sets the slave device for @event to @device.
-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.
+The event must have been allocated by GTK+,
+for instance by gdk_event_copy().
-Since: 2.10
+Since: 3.0
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<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_window_begin_resize_drag">
+<function name="gdk_events_get_angle">
<description>
-Begins a window resize operation (for a toplevel window).
-You might use this function to implement a "window resize grip," for
-example; in fact #GtkStatusbar uses it. The function works best
-with window managers that support the <ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended Window Manager Hints</ulink>, but has a
-fallback implementation for other window managers.
+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="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 name="event1">
+<parameter_description> first #GdkEvent
</parameter_description>
</parameter>
-<parameter name="root_y">
-<parameter_description> root window Y coordinate of mouse click that began the drag
+<parameter name="event2">
+<parameter_description> second #GdkEvent
</parameter_description>
</parameter>
-<parameter name="timestamp">
-<parameter_description> timestamp of mouse click that began the drag (use gdk_event_get_time())
+<parameter name="angle">
+<parameter_description> return location for the relative angle between both events
</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.
+<return> %TRUE if the angle could be calculated.
-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>
+</return>
</function>
-<function name="gdk_cursor_new_from_pixmap">
+<function name="gdk_events_get_center">
<description>
-Creates a new cursor from a given pixmap and mask. Both the pixmap and mask
-must have a depth of 1 (i.e. each pixel has only 2 values - on or off).
-The standard cursor size is 16 by 16 pixels. You can create a bitmap
-from inline data as in the below example.
-
-<example><title>Creating a custom cursor</title>
-<programlisting>
-/<!-- -->* This data is in X bitmap format, and can be created with the 'bitmap'
-utility. *<!-- -->/
-define cursor1_width 16
-define cursor1_height 16
-static unsigned char cursor1_bits[] = {
-0x80, 0x01, 0x40, 0x02, 0x20, 0x04, 0x10, 0x08, 0x08, 0x10, 0x04, 0x20,
-0x82, 0x41, 0x41, 0x82, 0x41, 0x82, 0x82, 0x41, 0x04, 0x20, 0x08, 0x10,
-0x10, 0x08, 0x20, 0x04, 0x40, 0x02, 0x80, 0x01};
-
-static unsigned char cursor1mask_bits[] = {
-0x80, 0x01, 0xc0, 0x03, 0x60, 0x06, 0x30, 0x0c, 0x18, 0x18, 0x8c, 0x31,
-0xc6, 0x63, 0x63, 0xc6, 0x63, 0xc6, 0xc6, 0x63, 0x8c, 0x31, 0x18, 0x18,
-0x30, 0x0c, 0x60, 0x06, 0xc0, 0x03, 0x80, 0x01};
-
-
-GdkCursor *cursor;
-GdkPixmap *source, *mask;
-GdkColor fg = { 0, 65535, 0, 0 }; /<!-- -->* Red. *<!-- -->/
-GdkColor bg = { 0, 0, 0, 65535 }; /<!-- -->* Blue. *<!-- -->/
-
-
-source = gdk_bitmap_create_from_data (NULL, cursor1_bits,
-cursor1_width, cursor1_height);
-mask = gdk_bitmap_create_from_data (NULL, cursor1mask_bits,
-cursor1_width, cursor1_height);
-cursor = gdk_cursor_new_from_pixmap (source, mask, &fg, &bg, 8, 8);
-g_object_unref (source);
-g_object_unref (mask);
-
-
-gdk_window_set_cursor (widget->window, cursor);
-</programlisting>
-</example>
+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="source">
-<parameter_description> the pixmap specifying the cursor.
-</parameter_description>
-</parameter>
-<parameter name="mask">
-<parameter_description> the pixmap specifying the mask, which must be the same size as
- source
-</parameter_description>
-</parameter>
-<parameter name="fg">
-<parameter_description> the foreground color, used for the bits in the source which are 1.
-The color does not have to be allocated first.
+<parameter name="event1">
+<parameter_description> first #GdkEvent
</parameter_description>
</parameter>
-<parameter name="bg">
-<parameter_description> the background color, used for the bits in the source which are 0.
-The color does not have to be allocated first.
+<parameter name="event2">
+<parameter_description> second #GdkEvent
</parameter_description>
</parameter>
<parameter name="x">
-<parameter_description> the horizontal offset of the 'hotspot' of the cursor.
+<parameter_description> return location for the X coordinate of the center
</parameter_description>
</parameter>
<parameter name="y">
-<parameter_description> the vertical offset of the 'hotspot' of the cursor.
+<parameter_description> return location for the Y coordinate of the center
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkCursor.
+<return> %TRUE if the center could be calculated.
+
</return>
</function>
-<function name="gdk_draw_image">
+<function name="gdk_events_get_distance">
<description>
-Draws a #GdkImage onto a drawable.
-The depth of the #GdkImage must match the depth of the #GdkDrawable.
+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="drawable">
-<parameter_description> a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
-</parameter_description>
-</parameter>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
-</parameter_description>
-</parameter>
-<parameter name="image">
-<parameter_description> the #GdkImage to draw.
-</parameter_description>
-</parameter>
-<parameter name="xsrc">
-<parameter_description> the left edge of the source rectangle within @image.
-</parameter_description>
-</parameter>
-<parameter name="ysrc">
-<parameter_description> the top of the source rectangle within @image.
-</parameter_description>
-</parameter>
-<parameter name="xdest">
-<parameter_description> the x coordinate of the destination within @drawable.
-</parameter_description>
-</parameter>
-<parameter name="ydest">
-<parameter_description> the y coordinate of the destination within @drawable.
+<parameter name="event1">
+<parameter_description> first #GdkEvent
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> the width of the area to be copied, or -1 to make the area
-extend to the right edge of @image.
+<parameter name="event2">
+<parameter_description> second #GdkEvent
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> the height of the area to be copied, or -1 to make the area
-extend to the bottom edge of @image.
+<parameter name="distance">
+<parameter_description> return location for the distance
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the distance could be calculated.
+
+</return>
</function>
-<function name="gdk_pointer_is_grabbed">
+<function name="gdk_events_pending">
<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.
+Checks if any events are ready to be processed for any display.
</description>
<parameters>
</parameters>
-<return> %TRUE if the pointer is currently grabbed by this application.*
+<return> %TRUE if any events are pending.
</return>
</function>
-<function name="gdk_window_set_composited">
+<function name="gdk_flush">
<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 <xref linkend="composited-window-example"/>
-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
+Flushes the output buffers of all display connections and waits
+until all requests have been processed.
+This is rarely needed by applications.
</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_spawn_command_line_on_screen">
+<function name="gdk_get_default_root_window">
<description>
-Like g_spawn_command_line_async(), except the child process is
-spawned in such an environment that on calling gdk_display_open()
-it would be returned a #GdkDisplay with @screen as the default
-screen.
-
-This is useful for applications which wish to launch an application
-on a specific screen.
+Obtains the root window (parent all other windows are inside)
+for the default display and screen.
-Since: 2.4
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
-</parameter_description>
-</parameter>
-<parameter name="command_line">
-<parameter_description> a command line
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for errors
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE on success, %FALSE if error is set.
-
+<return> the default root window
</return>
</function>
-<function name="gdk_pango_renderer_set_override_color">
+<function name="gdk_get_display_arg_name">
<description>
-Sets the color for a particular render part (foreground,
-background, underline, etc.), overriding any attributes on the layouts
-renderered with this renderer.
+Gets the display name specified in the command line arguments passed
+to gdk_init() or gdk_parse_args(), if any.
-Since: 2.6
+Since: 2.2
</description>
<parameters>
-<parameter name="gdk_renderer">
-<parameter_description> a #GdkPangoRenderer
-</parameter_description>
-</parameter>
-<parameter name="part">
-<parameter_description> the part to render to set the color of
-</parameter_description>
-</parameter>
-<parameter name="color">
-<parameter_description> the color to use, or %NULL to unset a previously
-set override color.
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<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_string_to_compound_text_for_display">
+<function name="gdk_get_program_class">
<description>
-Convert a string from the encoding of the current
-locale into a form suitable for storing in a window property.
+Gets the program class. Unless the program class has explicitly
+been set with gdk_set_program_class() or with the <option>--class</option>
+commandline option, the default value is the program name (determined
+with g_get_prgname()) with the first character converted to uppercase.
-Since: 2.2
</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 @text, in bytes
-</parameter_description>
-</parameter>
</parameters>
-<return> 0 upon success, non-zero upon failure.
-
+<return> the program class.
</return>
</function>
-<function name="gdk_drawable_get_colormap">
+<function name="gdk_get_show_events">
<description>
-Gets the colormap for @drawable, if one is set; returns
-%NULL otherwise.
+Gets whether event debugging output is enabled.
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
-</parameter_description>
-</parameter>
</parameters>
-<return> the colormap, or %NULL
+<return> %TRUE if event debugging output is enabled.
</return>
</function>
-<function name="gdk_image_unref">
+<function name="gdk_init">
<description>
-Deprecated function; use g_object_unref() instead.
+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 <literal>exit(1)</literal>.
+
+Any arguments used by GDK are removed from the array and @argc and @argv
+are updated accordingly.
-Deprecated: 2.0: Use g_object_unref() instead.
+GTK+ initializes GDK in gtk_init() and so this function is not usually
+needed by GTK+ applications.
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GdkImage
+<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_display_supports_input_shapes">
+<function name="gdk_init_check">
<description>
-Returns %TRUE if gdk_window_input_shape_combine_mask() can
-be used to modify the input shape of windows on @display.
+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.
-Since: 2.10
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<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 windows with modified input shape are supported
-
+<return> %TRUE if initialization succeeded.
</return>
</function>
-<function name="gdk_window_get_events">
+<function name="gdk_keyboard_grab">
<description>
-Gets the event mask for @window. See gdk_window_set_events().
+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> a #GdkWindow
+<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> event mask for @window
+<return> %GDK_GRAB_SUCCESS if the grab was successful.
+
</return>
</function>
-<function name="gdk_pixmap_colormap_create_from_xpm">
+<function name="gdk_keyboard_ungrab">
<description>
-Create a pixmap from a XPM file using a particular colormap.
+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="drawable">
-<parameter_description> a #GdkDrawable, used to determine default values
-for the new pixmap. Can be %NULL if @colormap is given.
-</parameter_description>
-</parameter>
-<parameter name="colormap">
-<parameter_description> the #GdkColormap that the new pixmap will be use.
-If omitted, the colormap for @window will be used.
-</parameter_description>
-</parameter>
-<parameter name="mask">
-<parameter_description> a pointer to a place to store a bitmap representing
-the transparency mask of the XPM file. Can be %NULL,
-in which case transparency will be ignored.
-</parameter_description>
-</parameter>
-<parameter name="transparent_color">
-<parameter_description> the color to be used for the pixels
-that are transparent in the input file. Can be %NULL,
-in which case a default color will be used.
-</parameter_description>
-</parameter>
-<parameter name="filename">
-<parameter_description> the filename of a file containing XPM data.
+<parameter name="time_">
+<parameter_description> a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no
+timestamp is available.
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkPixmap.
-</return>
+<return></return>
</function>
-<function name="gdk_window_set_transient_for">
+<function name="gdk_keymap_add_virtual_modifiers">
<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.
+Adds virtual modifiers (i.e. Super, Hyper and Meta) which correspond
+to the real modifiers (i.e Mod2, Mod3, ...) in @modifiers.
+are set in @state to their non-virtual counterparts (i.e. Mod2,
+Mod3,...) and set the corresponding bits in @state.
-See gtk_window_set_transient_for() if you're using #GtkWindow or
-#GtkDialog.
+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="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="keymap">
+<parameter_description> a #GdkKeymap
</parameter_description>
</parameter>
-<parameter name="parent">
-<parameter_description> another toplevel #GdkWindow
+<parameter name="state">
+<parameter_description> pointer to the modifier mask to change
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_destroy">
+<function name="gdk_keymap_get_caps_lock_state">
<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.
+Returns whether the Caps Lock modifer is locked.
+Since: 2.16
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="keymap">
+<parameter_description> a #GdkKeymap
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if Caps Lock is on
+
+</return>
</function>
-<function name="gdk_events_pending">
+<function name="gdk_keymap_get_default">
<description>
-Checks if any events are ready to be processed for any display.
+Returns the #GdkKeymap attached to the default display.
</description>
<parameters>
</parameters>
-<return> %TRUE if any events are pending.
+<return> the #GdkKeymap attached to the default display.
</return>
</function>
-<function name="gdk_gc_set_exposures">
+<function name="gdk_keymap_get_direction">
<description>
-Sets whether copying non-visible portions of a drawable
-using this graphics context generate exposure events
-for the corresponding regions of the destination
-drawable. (See gdk_draw_drawable()).
+Returns the direction of effective layout of the keymap.
+
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
-</parameter_description>
-</parameter>
-<parameter name="exposures">
-<parameter_description> if %TRUE, exposure events will be generated.
+<parameter name="keymap">
+<parameter_description> a #GdkKeymap
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %PANGO_DIRECTION_LTR or %PANGO_DIRECTION_RTL
+if it can determine the direction. %PANGO_DIRECTION_NEUTRAL
+otherwise.
+</return>
</function>
-<function name="gdk_screen_get_monitor_at_point">
+<function name="gdk_keymap_get_entries_for_keycode">
<description>
-Returns the monitor number in which the point (@x,@y) is located.
+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().
-Since: 2.2
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen.
+<parameter name="keymap">
+<parameter_description> a #GdkKeymap
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> the x coordinate in the virtual screen.
+<parameter name="hardware_keycode">
+<parameter_description> a keycode
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the y coordinate in the virtual screen.
+<parameter name="keys">
+<parameter_description> return
+location for array of #GdkKeymapKey, or %NULL
</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_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 name="keyvals">
+<parameter_description> return
+location for array of keyvals, or %NULL
</parameter_description>
</parameter>
-<parameter name="modal">
-<parameter_description> %TRUE if the window is modal, %FALSE otherwise.
+<parameter name="n_entries">
+<parameter_description> length of @keys and @keyvals
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if there were any entries
+</return>
</function>
-<function name="gdk_drag_get_protocol_for_display">
+<function name="gdk_keymap_get_entries_for_keyval">
<description>
-Finds out the DND protocol supported by a window.
+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().
-Since: 2.2
</description>
<parameters>
-<parameter name="display">
-<parameter_description> the #GdkDisplay where the destination window resides
+<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="xid">
-<parameter_description> the windowing system id of the destination window.
+<parameter name="keys">
+<parameter_description> return location
+for an array of #GdkKeymapKey
</parameter_description>
</parameter>
-<parameter name="protocol">
-<parameter_description> location where the supported DND protocol is returned.
+<parameter name="n_keys">
+<parameter_description> return location for number of elements in returned array
</parameter_description>
</parameter>
</parameters>
-<return> the windowing system id of the window where the drop should happen. This
-may be @xid or the id of a proxy window, or zero if @xid doesn't
-support Drag and Drop.
+<return> %TRUE if keys were found and returned
</return>
</function>
-<function name="gdk_font_ref">
+<function name="gdk_keymap_get_for_display">
<description>
-Increases the reference count of a font by one.
+Returns the #GdkKeymap attached to @display.
+Since: 2.2
</description>
<parameters>
-<parameter name="font">
-<parameter_description> a #GdkFont
+<parameter name="display">
+<parameter_description> the #GdkDisplay.
</parameter_description>
</parameter>
</parameters>
-<return> @font
+<return> the #GdkKeymap attached to @display.
+
</return>
</function>
-<function name="gdk_keyboard_grab_info_libgtk_only">
+<function name="gdk_keymap_get_num_lock_state">
<description>
-Determines information about the current keyboard grab.
-This is not public API and must not be used by applications.
+Returns whether the Num Lock modifer is locked.
+Since: 3.0
</description>
<parameters>
-<parameter name="display">
-<parameter_description> the display for which to get the grab information
-</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() was %TRUE.
+<parameter name="keymap">
+<parameter_description> a #GdkKeymap
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if this application currently has the
-keyboard grabbed.
+<return> %TRUE if Num Lock is on
+
</return>
</function>
-<function name="gdk_pixmap_lookup">
+<function name="gdk_keymap_have_bidi_layouts">
<description>
-Looks up the #GdkPixmap that wraps the given native pixmap handle.
-
-For example in the X backend, a native pixmap handle is an Xlib
-<type>XID</type>.
+Determines if keyboard layouts for both right-to-left and left-to-right
+languages are in use.
+Since: 2.12
</description>
<parameters>
-<parameter name="anid">
-<parameter_description> a native pixmap handle.
+<parameter name="keymap">
+<parameter_description> a #GdkKeymap
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkPixmap wrapper for the native pixmap,
-or %NULL if there is none.
+<return> %TRUE if there are layouts in both directions, %FALSE otherwise
+
</return>
</function>
-<function name="gdk_draw_layout_line">
+<function name="gdk_keymap_lookup_key">
<description>
-Render a #PangoLayoutLine onto an GDK drawable
+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.
-If the layout's #PangoContext has a transformation matrix set, then
- x and @y specify the position of the left edge of the baseline
-(left is in before-tranform user coordinates) in after-transform
-device coordinates.
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> the drawable on which to draw the line
+<parameter name="keymap">
+<parameter_description> a #GdkKeymap
</parameter_description>
</parameter>
-<parameter name="gc">
-<parameter_description> base graphics to use
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x position of start of string (in pixels)
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> the y position of baseline (in pixels)
-</parameter_description>
-</parameter>
-<parameter name="line">
-<parameter_description> a #PangoLayoutLine
+<parameter name="key">
+<parameter_description> a #GdkKeymapKey with keycode, group, and level initialized
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a keyval, or 0 if none was mapped to the given @key
+</return>
</function>
-<function name="gdk_display_peek_event">
+<function name="gdk_keymap_map_virtual_modifiers">
<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.)
+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.
-Since: 2.2
+This function is useful when matching key events against
+accelerators.
+
+Since: 2.20
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<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> 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> %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_gc_set_rgb_bg_color">
+<function name="gdk_keymap_translate_keyboard_state">
<description>
-Set the background color of a GC using an unallocated color. The
-pixel value for the color will be determined using GdkRGB. If the
-colormap for the GC has not previously been initialized for GdkRGB,
-then for pseudo-color colormaps (colormaps with a small modifiable
-number of colors), a colorcube will be allocated in the colormap.
+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 <xref linkend="key-group-explanation"/> 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.
+
+<note><para>
+ 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 <literal>plus</literal>
+symbol is shifted, so when comparing a key press to a
+<literal><Control>plus</literal> accelerator <Shift> should
+be masked out.
+</para>
+<informalexample><programlisting>
+ / * We want to ignore irrelevant modifiers like ScrollLock * /
+#define ALL_ACCELS_MASK (GDK_CONTROL_MASK | GDK_SHIFT_MASK | GDK_MOD1_MASK)
+gdk_keymap_translate_keyboard_state (keymap, event->hardware_keycode,
+event->state, event->group,
+&keyval, NULL, NULL, &consumed);
+if (keyval == GDK_PLUS &&
+(event->state & ~consumed & ALL_ACCELS_MASK) == GDK_CONTROL_MASK)
+ / * Control was pressed * /
+</programlisting></informalexample>
+<para>
+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:</para>
+<informalexample><programlisting>
+ / * XXX Don't do this XXX * /
+if (keyval == accel_keyval &&
+(event->state & ~consumed & ALL_ACCELS_MASK) == (accel_mods & ~consumed))
+ / * Accelerator was pressed * /
+</programlisting></informalexample>
+<para>
+However, this did not work if multi-modifier combinations were
+used in the keymap, since, for instance, <literal><Control></literal>
+would be masked out even if only <literal><Control><Alt></literal>
+was used in the keymap. To support this usage as well as well as
+possible, all <emphasis>single modifier</emphasis> 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 <literal><Control>plus</literal>,
+not <literal><Control><Shift>plus</literal>,
+</para></note>
-Calling this function for a GC without a colormap is an error.
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC
+<parameter name="keymap">
+<parameter_description> a #GdkKeymap
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> an unallocated #GdkColor.
+<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></return>
+<return> %TRUE if there was a keyval bound to the keycode/state/group
+</return>
</function>
-<function name="gdk_window_move">
+<function name="gdk_keyval_convert_case">
<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.
+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="window">
-<parameter_description> a #GdkWindow
+<parameter name="symbol">
+<parameter_description> a keyval
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> X coordinate relative to window's parent
+<parameter name="lower">
+<parameter_description> return location for lowercase version of @symbol
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> Y coordinate relative to window's parent
+<parameter name="upper">
+<parameter_description> return location for uppercase version of @symbol
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_x11_window_move_to_current_desktop">
+<function name="gdk_keyval_from_name">
<description>
-Moves the window to the correct workspace when running under a
-window manager that supports multiple workspaces, as described
-in the <ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended
-Window Manager Hints</ulink>. Will not do anything if the
-window is already on all workspaces.
+Converts a key name to a key value.
+
+The names are the same as those in the
+<filename><gdk/gdkkeysyms.h></filename> header file
+but without the leading "GDK_KEY_".
-Since: 2.8
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="keyval_name">
+<parameter_description> a key name
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the corresponding key value, or %GDK_KEY_VoidSymbol
+if the key name is not a valid key
+</return>
</function>
-<function name="gdk_display_manager_get_default_display">
+<function name="gdk_keyval_is_lower">
<description>
-Gets the default #GdkDisplay.
+Returns %TRUE if the given key value is in lower case.
-Since: 2.2
</description>
<parameters>
-<parameter name="display_manager">
-<parameter_description> a #GdkDisplayManager
+<parameter name="keyval">
+<parameter_description> a key value.
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkDisplay, or %NULL if there is no default
-display.
-
+<return> %TRUE if @keyval is in lower case, or if @keyval is not
+subject to case conversion.
</return>
</function>
-<function name="gdk_window_set_cursor">
+<function name="gdk_keyval_is_upper">
<description>
-Sets the mouse pointer for a #GdkWindow. Use gdk_cursor_new_for_display()
-or gdk_cursor_new_from_pixmap() 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.
+Returns %TRUE if the given key value is in upper case.
+
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="cursor">
-<parameter_description> a cursor
+<parameter name="keyval">
+<parameter_description> a key value.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @keyval is in upper case, or if @keyval is not subject to
+case conversion.
+</return>
</function>
-<function name="gdk_drop_finish">
+<function name="gdk_keyval_name">
<description>
-Ends the drag operation after a drop.
+Converts a key value into a symbolic name.
+
+The names are the same as those in the
+<filename><gdk/gdkkeysyms.h></filename> header file
+but without the leading "GDK_KEY_".
-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 name="keyval">
+<parameter_description> a key value
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<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_window_thaw_toplevel_updates_libgtk_only">
+<function name="gdk_keyval_to_lower">
<description>
-Thaws a window frozen with
-gdk_window_freeze_toplevel_updates_libgtk_only().
+Converts a key value to lower case, if applicable.
-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 name="keyval">
+<parameter_description> a key value.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<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_window_maximize">
+<function name="gdk_keyval_to_unicode">
<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
-"maximized"; 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.
+Convert from a GDK key symbol to the corresponding ISO10646 (Unicode)
+character.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="keyval">
+<parameter_description> a GDK key symbol
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the corresponding unicode character, or 0 if there
+is no corresponding character.
+</return>
</function>
-<function name="gdk_app_launch_context_set_screen">
+<function name="gdk_keyval_to_upper">
<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.
+Converts a key value to upper case, if applicable.
-Since: 2.14
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GdkAppLaunchContext
-</parameter_description>
-</parameter>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="keyval">
+<parameter_description> a key value.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<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_window_process_all_updates">
+<function name="gdk_list_visuals">
<description>
-Calls gdk_window_process_updates() for all windows (see #GdkWindow)
-in the application.
+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></return>
+<return>
+a list of visuals; the list must be freed, but not its contents
+</return>
</function>
-<function name="gdk_window_set_skip_pager_hint">
+<function name="gdk_notify_startup_complete">
<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
-<emphasis>not</emphasis> be called in addition, instead you should
-allow the window to be treated according to standard policy for
-its semantic type.
+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>
-<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_get_display_arg_name">
+<function name="gdk_notify_startup_complete_with_id">
<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.
+Indicates to the GUI environment that the application has
+finished loading, using a given identifier.
-</return>
-</function>
+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.
-<function name="gdk_region_get_rectangles">
-<description>
-Obtains the area covered by the region as a list of rectangles.
-The array returned in @rectangles must be freed with g_free().
+Since: 2.12
</description>
<parameters>
-<parameter name="region">
-<parameter_description> a #GdkRegion
-</parameter_description>
-</parameter>
-<parameter name="rectangles">
-<parameter_description> return location for an array of rectangles
-</parameter_description>
-</parameter>
-<parameter name="n_rectangles">
-<parameter_description> length of returned array
+<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_colormap_get_system_size">
+<function name="gdk_offscreen_window_get_embedder">
<description>
-Returns the size of the system's default colormap.
-(See the description of struct #GdkColormap for an
-explanation of the size of a colormap.)
+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 size of the system's default colormap.
+<return> the embedding #GdkWindow, or %NULL
+if @window is not an mbedded offscreen window
+
</return>
</function>
-<function name="gdk_colormap_alloc_color">
+<function name="gdk_offscreen_window_get_surface">
<description>
-Allocates a single color from a colormap.
+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="colormap">
-<parameter_description> a #GdkColormap.
-</parameter_description>
-</parameter>
-<parameter name="color">
-<parameter_description> the color to allocate. On return the
-<structfield>pixel</structfield> field will be
-filled in if allocation succeeds.
-</parameter_description>
-</parameter>
-<parameter name="writeable">
-<parameter_description> If %TRUE, the color is allocated writeable
-(their values can later be changed using gdk_color_change()).
-Writeable colors cannot be shared between applications.
-</parameter_description>
-</parameter>
-<parameter name="best_match">
-<parameter_description> If %TRUE, GDK will attempt to do matching against
-existing colors if the color cannot be allocated as requested.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the allocation succeeded.
+<return> The offscreen surface, or %NULL if not offscreen
</return>
</function>
-<function name="gdk_window_beep">
+<function name="gdk_offscreen_window_set_embedder">
<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().
+Sets @window to be embedded in @embedder.
-Since: 2.12
+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 toplevel #GdkWindow
+<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_screen_get_rgb_visual">
+<function name="gdk_pango_context_get">
<description>
-Gets a "preferred visual" chosen by GdkRGB for rendering image data
-on @screen. In previous versions of
-GDK, this was the only visual GdkRGB could use for rendering. In
-current versions, it's simply the visual GdkRGB would have chosen as
-the optimal one in those previous versions. GdkRGB can now render to
-drawables with any visual.
+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.
-Since: 2.2
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
-</parameter_description>
-</parameter>
</parameters>
-<return> The #GdkVisual chosen by GdkRGB.
-
+<return> a new #PangoContext for the default display
</return>
</function>
@@ -5460,3782 +4699,4043 @@ Since: 2.2
</return>
</function>
-<function name="gdk_xid_table_lookup_for_display">
+<function name="gdk_pango_layout_get_clip_region">
<description>
-Returns the GDK object associated with the given X id.
+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.
-Since: 2.2
</description>
<parameters>
-<parameter name="display">
-<parameter_description> the #GdkDisplay.
+<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="xid">
-<parameter_description> an X id.
+<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> the associated Gdk object, which may be a #GdkPixmap,
-a #GdkWindow or a #GdkFont or %NULL if no object is associated
-with the X id.
-
+<return> a clip region containing the given ranges
</return>
</function>
-<function name="gdk_app_launch_context_set_desktop">
+<function name="gdk_pango_layout_line_get_clip_region">
<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
-<ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended
-Window Manager Hints</ulink>.
+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.
-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.
+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.
-Since: 2.14
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GdkAppLaunchContext
+<parameter name="line">
+<parameter_description> a #PangoLayoutLine
</parameter_description>
</parameter>
-<parameter name="desktop">
-<parameter_description> the number of a workspace, or -1
+<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></return>
+<return> a clip region containing the given ranges
+</return>
</function>
-<function name="gdk_colormap_unref">
+<function name="gdk_parse_args">
<description>
-Deprecated function; use g_object_unref() instead.
+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.
-Deprecated: 2.0: Use g_object_unref() instead.
+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="cmap">
-<parameter_description> a #GdkColormap
+<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_screen_get_system_visual">
+<function name="gdk_pixbuf_add_alpha">
<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.
+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.
-Since: 2.2
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen.
+<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> the system visual
-
+<return> A newly-created pixbuf with a reference count of 1.
</return>
</function>
-<function name="gdk_window_remove_filter">
+<function name="gdk_pixbuf_animation_get_height">
<description>
-Remove a filter previously added with gdk_window_add_filter().
+Queries the height of the bounding box of a pixbuf animation.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="animation">
+<parameter_description> An animation.
</parameter_description>
</parameter>
-<parameter name="function">
-<parameter_description> previously-added filter function
+</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 "infinite."
+
+
+</description>
+<parameters>
+<parameter name="animation">
+<parameter_description> a #GdkPixbufAnimation
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> user data for previously-added filter function
+<parameter name="start_time">
+<parameter_description> time when the animation starts playing
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> an iterator to move over the animation
+</return>
</function>
-<function name="gdk_event_get_coords">
+<function name="gdk_pixbuf_animation_get_static_image">
<description>
-Extract the event window relative x/y coordinates from an event.
+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="event">
-<parameter_description> a #GdkEvent
-</parameter_description>
-</parameter>
-<parameter name="x_win">
-<parameter_description> location to put event window x coordinate
+<parameter name="animation">
+<parameter_description> a #GdkPixbufAnimation
</parameter_description>
</parameter>
-<parameter name="y_win">
-<parameter_description> location to put event window y coordinate
+</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> %TRUE if the event delivered event window coordinates
+<return> Width of the bounding box of the animation.
</return>
</function>
-<function name="gdk_event_send_clientmessage_toall">
+<function name="gdk_pixbuf_animation_is_static_image">
<description>
-Sends an X ClientMessage event to all toplevel windows on the default
-#GdkScreen.
+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.
-Toplevel windows are determined by checking for the WM_STATE property, as
-described in the Inter-Client Communication Conventions Manual (ICCCM).
-If no windows are found with the WM_STATE property set, the message is sent
-to all children of the root window.
</description>
<parameters>
-<parameter name="event">
-<parameter_description> the #GdkEvent to send, which should be a #GdkEventClient.
+<parameter name="animation">
+<parameter_description> a #GdkPixbufAnimation
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the "animation" was really just an image
+</return>
</function>
-<function name="gdk_draw_arc">
+<function name="gdk_pixbuf_animation_iter_advance">
<description>
-Draws an arc or a filled 'pie slice'. The arc is defined by the bounding
-rectangle of the entire ellipse, and the start and end angles of the part
-of the ellipse to be drawn.
+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_animation_iter_get_pixbuf() and update the
+display with the new pixbuf.
+
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
+<parameter name="iter">
+<parameter_description> a #GdkPixbufAnimationIter
</parameter_description>
</parameter>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
-</parameter_description>
-</parameter>
-<parameter name="filled">
-<parameter_description> %TRUE if the arc should be filled, producing a 'pie slice'.
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x coordinate of the left edge of the bounding rectangle.
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> the y coordinate of the top edge of the bounding rectangle.
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> the width of the bounding rectangle.
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> the height of the bounding rectangle.
-</parameter_description>
-</parameter>
-<parameter name="angle1">
-<parameter_description> the start angle of the arc, relative to the 3 o'clock position,
-counter-clockwise, in 1/64ths of a degree.
-</parameter_description>
-</parameter>
-<parameter name="angle2">
-<parameter_description> the end angle of the arc, relative to @angle1, in 1/64ths
-of a degree.
+<parameter name="current_time">
+<parameter_description> current time
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the image may need updating
+
+</return>
</function>
-<function name="gdk_x11_cursor_get_xdisplay">
+<function name="gdk_pixbuf_animation_iter_get_delay_time">
<description>
-Returns the display of a #GdkCursor.
+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="cursor">
-<parameter_description> a #GdkCursor.
+<parameter name="iter">
+<parameter_description> an animation iterator
</parameter_description>
</parameter>
</parameters>
-<return> an Xlib <type>Display*</type>.
+<return> delay time in milliseconds (thousandths of a second)
</return>
</function>
-<function name="gdk_pango_layout_get_clip_region">
+<function name="gdk_pixbuf_animation_iter_get_pixbuf">
<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 same position
-you would pass to gdk_draw_layout_line(). @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.
+Gets the current pixbuf which should be displayed; the pixbuf will
+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="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 name="iter">
+<parameter_description> an animation iterator
</parameter_description>
</parameter>
</parameters>
-<return> a clip region containing the given ranges
+<return> the pixbuf to be displayed
</return>
</function>
-<function name="gdk_notify_startup_complete">
+<function name="gdk_pixbuf_animation_iter_on_currently_loading_frame">
<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>
+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.
-<function name="gdk_gc_set_clip_mask">
-<description>
-Sets the clip mask for a graphics context from a bitmap.
-The clip mask is interpreted relative to the clip
-origin. (See gdk_gc_set_clip_origin()).
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> the #GdkGC.
-</parameter_description>
-</parameter>
-<parameter name="mask">
-<parameter_description> a bitmap.
+<parameter name="iter">
+<parameter_description> a #GdkPixbufAnimationIter
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the frame we're on is partially loaded, or the last frame
+</return>
</function>
-<function name="gdk_rectangle_intersect">
+<function name="gdk_pixbuf_animation_new_from_file">
<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.
+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="src1">
-<parameter_description> a #GdkRectangle
-</parameter_description>
-</parameter>
-<parameter name="src2">
-<parameter_description> a #GdkRectangle
+<parameter name="filename">
+<parameter_description> Name of file to load, in the GLib file name encoding
</parameter_description>
</parameter>
-<parameter name="dest">
-<parameter_description> return location for the intersection of @src1 and @src2, or %NULL
+<parameter name="error">
+<parameter_description> return location for error
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the rectangles intersect.
+<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_device_get_state">
+<function name="gdk_pixbuf_animation_ref">
<description>
-Gets the current state of a device.
+Adds a reference to an animation.
+
+Deprecated: 2.0: Use g_object_ref().
</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 name="animation">
+<parameter_description> An animation.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The same as the @animation argument.
+
+</return>
</function>
-<function name="gdk_drawable_get_display">
+<function name="gdk_pixbuf_animation_unref">
<description>
-Gets the #GdkDisplay associated with a #GdkDrawable.
+Removes a reference from an animation.
-Since: 2.2
+Deprecated: 2.0: Use g_object_unref().
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<parameter name="animation">
+<parameter_description> An animation.
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkDisplay associated with @drawable
-
-</return>
+<return></return>
</function>
-<function name="gdk_gc_ref">
+<function name="gdk_pixbuf_apply_embedded_orientation">
<description>
-Deprecated function; use g_object_ref() instead.
+Takes an existing pixbuf and checks for the presence of an
+associated "orientation" 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.
-Deprecated: 2.0: Use g_object_ref() instead.
+Since: 2.12
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC
+<parameter name="src">
+<parameter_description> A #GdkPixbuf.
</parameter_description>
</parameter>
</parameters>
-<return> the gc.
+<return> A newly-created pixbuf, or a reference to the
+input pixbuf (with an increased reference count).
</return>
</function>
-<function name="gdk_draw_rectangle">
+<function name="gdk_pixbuf_composite">
<description>
-Draws a rectangular outline or filled rectangle, using the foreground color
-and other attributes of the #GdkGC.
+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.
-A rectangle drawn filled is 1 pixel smaller in both dimensions than a
-rectangle outlined. Calling
-<literal>gdk_draw_rectangle (window, gc, TRUE, 0, 0, 20, 20)</literal>
-results in a filled rectangle 20 pixels wide and 20 pixels high. Calling
-<literal>gdk_draw_rectangle (window, gc, FALSE, 0, 0, 20, 20)</literal>
-results in an outlined rectangle with corners at (0, 0), (0, 20), (20, 20),
-and (20, 0), which makes it 21 pixels wide and 21 pixels high.
+<figure id="pixbuf-composite-diagram">
+<title>Compositing of pixbufs</title>
+<graphic fileref="composite.png" format="PNG"/>
+</figure>
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
+<parameter name="src">
+<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
+<parameter name="dest">
+<parameter_description> the #GdkPixbuf into which to render the results
</parameter_description>
</parameter>
-<parameter name="filled">
-<parameter_description> %TRUE if the rectangle should be filled.
+<parameter name="dest_x">
+<parameter_description> the left coordinate for region to render
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> the x coordinate of the left edge of the rectangle.
+<parameter name="dest_y">
+<parameter_description> the top coordinate for region to render
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the y coordinate of the top edge of the rectangle.
+<parameter name="dest_width">
+<parameter_description> the width of the region to render
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> the width of the rectangle.
+<parameter name="dest_height">
+<parameter_description> the height of the region to render
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> the height of the rectangle.
+<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_window_set_group">
+<function name="gdk_pixbuf_composite_color">
<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.
+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.
-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 name="src">
+<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
-<parameter name="leader">
-<parameter_description> group leader window, or %NULL to restore the default group leader window
+<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_window_resize">
+<function name="gdk_pixbuf_composite_color_simple">
<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.
+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.
-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 name="src">
+<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> new width of the window
+<parameter name="dest_width">
+<parameter_description> the width of destination image
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> new height of the window
+<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></return>
+<return> the new #GdkPixbuf, or %NULL if not enough memory could be
+allocated for it.
+</return>
</function>
-<function name="gdk_x11_grab_server">
+<function name="gdk_pixbuf_copy">
<description>
-Call gdk_x11_display_grab() on the default display.
-To ungrab the server again, use gdk_x11_ungrab_server().
+Creates a new #GdkPixbuf with a copy of the information in the specified
+ pixbuf
-gdk_x11_grab_server()/gdk_x11_ungrab_server() calls can be nested.
</description>
<parameters>
+<parameter name="pixbuf">
+<parameter_description> A pixbuf.
+</parameter_description>
+</parameter>
</parameters>
-<return></return>
+<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_keyval_convert_case">
+<function name="gdk_pixbuf_copy_area">
<description>
-Obtains the upper- and lower-case versions of the keyval @symbol.
-Examples of keyvals are #GDK_a, #GDK_Enter, #GDK_F1, etc.
+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="symbol">
-<parameter_description> a keyval
+<parameter name="src_pixbuf">
+<parameter_description> Source pixbuf.
</parameter_description>
</parameter>
-<parameter name="lower">
-<parameter_description> return location for lowercase version of @symbol
+<parameter name="src_x">
+<parameter_description> Source X coordinate within @src_pixbuf.
</parameter_description>
</parameter>
-<parameter name="upper">
-<parameter_description> return location for uppercase version of @symbol
+<parameter name="src_y">
+<parameter_description> Source Y coordinate within @src_pixbuf.
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gdk_draw_point">
-<description>
-Draws a point, using the foreground color and other attributes of
-the #GdkGC.
-
-</description>
-<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
+<parameter name="width">
+<parameter_description> Width of the area to copy.
</parameter_description>
</parameter>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
+<parameter name="height">
+<parameter_description> Height of the area to copy.
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> the x coordinate of the point.
+<parameter name="dest_pixbuf">
+<parameter_description> Destination pixbuf.
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the y coordinate of the point.
+<parameter name="dest_x">
+<parameter_description> X coordinate within @dest_pixbuf.
</parameter_description>
</parameter>
-</parameters>
-<return></return>
+<parameter name="dest_y">
+<parameter_description> Y coordinate within @dest_pixbuf.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="gdk_display_store_clipboard">
+<function name="gdk_pixbuf_fill">
<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
-<ulink url="http://www.freedesktop.org/Standards/clipboard-manager-spec">
-http://www.freedesktop.org/Standards/clipboard-manager-spec</ulink>.
+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.
-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 name="pixbuf">
+<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
-<parameter name="n_targets">
-<parameter_description> length of the @targets array
+<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_x11_font_get_xdisplay">
+<function name="gdk_pixbuf_flip">
<description>
-Returns the display of a #GdkFont.
+Flips a pixbuf horizontally or vertically and returns the
+result in a new pixbuf.
+Since: 2.6
</description>
<parameters>
-<parameter name="font">
-<parameter_description> a #GdkFont.
+<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> an Xlib <type>Display*</type>.
+<return> the new #GdkPixbuf, or %NULL if not enough memory could be
+allocated for it.
+
</return>
</function>
-<function name="gdk_draw_trapezoids">
+<function name="gdk_pixbuf_format_copy">
<description>
-Draws a set of anti-aliased trapezoids. The trapezoids are
-combined using saturation addition, then drawn over the background
-as a set. This is low level functionality used internally to implement
-rotated underlines and backgrouds when rendering a PangoLayout and is
-likely not useful for applications.
+Creates a copy of @format
-Since: 2.6
+Since: 2.22
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
-</parameter_description>
-</parameter>
-<parameter name="gc">
-<parameter_description> a #GdkGC
-</parameter_description>
-</parameter>
-<parameter name="trapezoids">
-<parameter_description> an array of #GdkTrapezoid structures
-</parameter_description>
-</parameter>
-<parameter name="n_trapezoids">
-<parameter_description> the number of trapezoids to draw
+<parameter name="format">
+<parameter_description> a #GdkPixbufFormat
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the newly allocated copy of a #GdkPixbufFormat. Use
+gdk_pixbuf_format_free() to free the resources when done
+
+</return>
</function>
-<function name="gdk_drawable_get_size">
+<function name="gdk_pixbuf_format_free">
<description>
-Fills * width and * height with the size of @drawable.
- width or @height can be %NULL if you only want the other one.
-
-On the X11 platform, if @drawable is a #GdkWindow, the returned
-size is the size reported in the most-recently-processed configure
-event, rather than the current size on the X server.
+Frees the resources allocated when copying a #GdkPixbufFormat
+using gdk_pixbuf_format_copy()
+Since: 2.22
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> location to store drawable's width, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> location to store drawable's height, or %NULL
+<parameter name="format">
+<parameter_description> a #GdkPixbufFormat
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_x11_screen_lookup_visual">
+<function name="gdk_pixbuf_format_get_description">
<description>
-Looks up the #GdkVisual for a particular screen and X Visual ID.
+Returns a description of the format.
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 name="format">
+<parameter_description> a #GdkPixbufFormat
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkVisual (owned by the screen object), or %NULL
-if the visual ID wasn't found.
+<return> a description of the format.
</return>
</function>
-<function name="gdk_screen_get_primary_monitor">
+<function name="gdk_pixbuf_format_get_extensions">
<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.
+Returns the filename extensions typically used for files in the
+given format.
-Since: 2.20
+Since: 2.2
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen.
+<parameter name="format">
+<parameter_description> a #GdkPixbufFormat
</parameter_description>
</parameter>
</parameters>
-<return> An integer index for the primary monitor, or 0 if none is configured.
+<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_win32_hdc_release">
+<function name="gdk_pixbuf_format_get_license">
<description>
-This function deallocates the Windows device context allocated by
-<funcion>gdk_win32_hdc_get()</function>. It should be called with
-the same parameters.
+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. "LGPL",
+"GPL", "QPL", "GPL/QPL", or "other" 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="drawable">
-<parameter_description> destination #GdkDrawable
-</parameter_description>
-</parameter>
-<parameter name="gc">
-<parameter_description> #GdkGC to use for drawing on @drawable
-</parameter_description>
-</parameter>
-<parameter name="usage">
-<parameter_description> mask indicating what properties were set up
+<parameter name="format">
+<parameter_description> a #GdkPixbufFormat
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a string describing the license of @format.
+
+</return>
</function>
-<function name="gdk_display_supports_selection_notification">
+<function name="gdk_pixbuf_format_get_mime_types">
<description>
-Returns whether #GdkEventOwnerChange events will be
-sent when the owner of a selection changes.
+Returns the mime types supported by the format.
-Since: 2.6
+Since: 2.2
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="format">
+<parameter_description> a #GdkPixbufFormat
</parameter_description>
</parameter>
</parameters>
-<return> whether #GdkEventOwnerChange events will
-be sent.
+<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_screen_get_display">
+<function name="gdk_pixbuf_format_get_name">
<description>
-Gets the display to which the @screen belongs.
+Returns the name of the format.
Since: 2.2
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="format">
+<parameter_description> a #GdkPixbufFormat
</parameter_description>
</parameter>
</parameters>
-<return> the display to which @screen belongs
+<return> the name of the format.
</return>
</function>
-<function name="gdk_window_get_state">
+<function name="gdk_pixbuf_format_is_disabled">
<description>
-Gets the bitwise OR of the currently active window state flags,
-from the #GdkWindowState enumeration.
+Returns whether this image format is disabled. See
+gdk_pixbuf_format_set_disabled().
+Since: 2.6
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="format">
+<parameter_description> a #GdkPixbufFormat
</parameter_description>
</parameter>
</parameters>
-<return> window state bitfield
+<return> whether this image format is disabled.
+
</return>
</function>
-<function name="gdk_x11_screen_get_screen_number">
+<function name="gdk_pixbuf_format_is_scalable">
<description>
-Returns the index of a #GdkScreen.
+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.2
+Since: 2.6
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen.
+<parameter name="format">
+<parameter_description> a #GdkPixbufFormat
</parameter_description>
</parameter>
</parameters>
-<return> the position of @screen among the screens of
-its display.
+<return> whether this image format is scalable.
+
</return>
</function>
-<function name="gdk_threads_add_idle_full">
+<function name="gdk_pixbuf_format_is_writable">
<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->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->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->idle_id)
-g_source_remove (self->idle_id);
-G_OBJECT_CLASS (parent_class)->finalize (object);
-}
-]|
+Returns whether pixbufs can be saved in the given format.
-Since: 2.12
+Since: 2.2
</description>
<parameters>
-<parameter name="priority">
-<parameter_description> the priority of the idle source. Typically this will be in the
-range btweeen #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 name="format">
+<parameter_description> a #GdkPixbufFormat
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
+<return> whether pixbufs can be saved in the given format.
</return>
</function>
-<function name="gdk_draw_glyphs_transformed">
+<function name="gdk_pixbuf_format_set_disabled">
<description>
-Renders a #PangoGlyphString onto a drawable, possibly
-transforming the layed-out coordinates through a transformation
-matrix. Note that the transformation matrix for @font is not
-changed, so to produce correct rendering results, the @font
-must have been loaded using a #PangoContext with an identical
-transformation matrix to that passed in to this function.
-
-See also gdk_draw_glyphs(), gdk_draw_layout().
+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="drawable">
-<parameter_description> a #GdkDrawable
-</parameter_description>
-</parameter>
-<parameter name="gc">
-<parameter_description> a #GdkGC
-</parameter_description>
-</parameter>
-<parameter name="matrix">
-<parameter_description> a #PangoMatrix, or %NULL to use an identity transformation
-</parameter_description>
-</parameter>
-<parameter name="font">
-<parameter_description> the font in which to draw the string
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x position of the start of the string (in Pango
-units in user space coordinates)
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> the y position of the baseline (in Pango units
-in user space coordinates)
+<parameter name="format">
+<parameter_description> a #GdkPixbufFormat
</parameter_description>
</parameter>
-<parameter name="glyphs">
-<parameter_description> the glyph string to draw
+<parameter name="disabled">
+<parameter_description> %TRUE to disable the format @format
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_get_user_data">
+<function name="gdk_pixbuf_from_pixdata">
<description>
-Retrieves the user data for @window, which is normally the widget
-that @window belongs to. See gdk_window_set_user_data().
+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="window">
-<parameter_description> a #GdkWindow
+<parameter name="pixdata">
+<parameter_description> a #GdkPixdata to convert into a #GdkPixbuf.
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> return location for user data
+<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></return>
+<return> a new #GdkPixbuf.
+</return>
</function>
-<function name="gdk_x11_font_get_xfont">
+<function name="gdk_pixbuf_get_bits_per_sample">
<description>
-Returns the X font belonging to a #GdkFont.
+Queries the number of bits per color sample in a pixbuf.
</description>
<parameters>
-<parameter name="font">
-<parameter_description> a #GdkFont.
+<parameter name="pixbuf">
+<parameter_description> A pixbuf.
</parameter_description>
</parameter>
</parameters>
-<return> an Xlib <type>XFontStruct*</type> or an <type>XFontSet</type>.
+<return> Number of bits per color sample.
</return>
</function>
-<function name="gdk_display_get_core_pointer">
+<function name="gdk_pixbuf_get_colorspace">
<description>
-Returns the core pointer device for the given display
+Queries the color space of a pixbuf.
-Since: 2.2
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="pixbuf">
+<parameter_description> A pixbuf.
</parameter_description>
</parameter>
</parameters>
-<return> the core pointer device; this is owned by the
-display and should not be freed.
-
+<return> Color space.
</return>
</function>
-<function name="gdk_x11_screen_get_monitor_output">
+<function name="gdk_pixbuf_get_file_info">
<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.
+Parses an image file far enough to determine its format and size.
-Since: 2.14
+Since: 2.4
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="filename">
+<parameter_description> The name of the file to identify.
</parameter_description>
</parameter>
-<parameter name="monitor_num">
-<parameter_description> number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
+<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> the XID of the monitor
+<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_notify_startup_complete_with_id">
+<function name="gdk_pixbuf_get_formats">
<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.
+Obtains the available information about the image formats supported
+by GdkPixbuf.
-Since: 2.12
+Since: 2.2
</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>
+<return> A list of
+#GdkPixbufFormat<!-- -->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_window_redirect_to_drawable">
+<function name="gdk_pixbuf_get_from_surface">
<description>
-Redirects drawing into @window so that drawing to the
-window in the rectangle specified by @src_x, @src_y,
- width and @height is also drawn into @drawable at
- dest_x, @dest_y.
+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.
-Only drawing between gdk_window_begin_paint_region() or
-gdk_window_begin_paint_rect() and gdk_window_end_paint() is
-redirected.
+This function will create an RGB pixbuf with 8 bits per channel.
+The pixbuf will contain an alpha channel if the @surface contains one.
-Redirection is active until gdk_window_remove_redirection()
-is called.
-
-Since: 2.14
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<parameter name="surface">
+<parameter_description> surface to copy from
</parameter_description>
</parameter>
<parameter name="src_x">
-<parameter_description> x position in @window
+<parameter_description> Source X coordinate within @surface
</parameter_description>
</parameter>
<parameter name="src_y">
-<parameter_description> y position in @window
-</parameter_description>
-</parameter>
-<parameter name="dest_x">
-<parameter_description> x position in @drawable
-</parameter_description>
-</parameter>
-<parameter name="dest_y">
-<parameter_description> y position in @drawable
+<parameter_description> Source Y coordinate within @surface
</parameter_description>
</parameter>
<parameter name="width">
-<parameter_description> width of redirection, or -1 to use the width of @window
+<parameter_description> Width in pixels of region to get
</parameter_description>
</parameter>
<parameter name="height">
-<parameter_description> height of redirection or -1 to use the height of @window
+<parameter_description> Height in pixels of region to get
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A newly-created pixbuf with a reference
+count of 1, or %NULL on error
+</return>
</function>
-<function name="gdk_pango_attr_embossed_new">
+<function name="gdk_pixbuf_get_from_window">
<description>
-Creates a new attribute flagging a region as embossed or not.
+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.
-</description>
-<parameters>
-<parameter name="embossed">
-<parameter_description> if the region should be embossed
-</parameter_description>
-</parameter>
-</parameters>
-<return> new #PangoAttribute
-</return>
-</function>
+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.
-<function name="gdk_display_keyboard_ungrab">
-<description>
-Release any keyboard grab
+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.)
-Since: 2.2
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay.
+<parameter name="window">
+<parameter_description> Source window
</parameter_description>
</parameter>
-<parameter name="time_">
-<parameter_description> a timestap (e.g #GDK_CURRENT_TIME).
+<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></return>
+<return> A newly-created pixbuf with a reference
+count of 1, or %NULL on error
+</return>
</function>
-<function name="gdk_net_wm_supports">
+<function name="gdk_pixbuf_get_has_alpha">
<description>
-This function is specific to the X11 backend of GDK, and indicates
-whether the window manager for the default screen supports a certain
-hint from the Extended Window Manager Hints Specification. See
-gdk_x11_screen_supports_net_wm_hint() for complete details.
+Queries whether a pixbuf has an alpha channel (opacity information).
</description>
<parameters>
-<parameter name="property">
-<parameter_description> a property atom.
+<parameter name="pixbuf">
+<parameter_description> A pixbuf.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the window manager supports @property
+<return> %TRUE if it has an alpha channel, %FALSE otherwise.
</return>
</function>
-<function name="gdk_window_stick">
+<function name="gdk_pixbuf_get_height">
<description>
-"Pins" 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.
+Queries the height of a pixbuf.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="pixbuf">
+<parameter_description> A pixbuf.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> Height in pixels.
+</return>
</function>
-<function name="gdk_screen_get_system_colormap">
+<function name="gdk_pixbuf_get_n_channels">
<description>
-Gets the system's default colormap for @screen
+Queries the number of channels of a pixbuf.
-Since: 2.2
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="pixbuf">
+<parameter_description> A pixbuf.
</parameter_description>
</parameter>
</parameters>
-<return> the default colormap for @screen.
-
+<return> Number of channels.
</return>
</function>
-<function name="gdk_x11_xatom_to_atom_for_display">
+<function name="gdk_pixbuf_get_option">
<description>
-Convert from an X atom for a #GdkDisplay to the corresponding
-#GdkAtom.
+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 "Title" and "Artist" options.
+The ICO, XBM, and XPM loaders provide "x_hot" and "y_hot" 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 "orientation" option string that corresponds to the embedded
+TIFF/Exif orientation tag (if present).
-Since: 2.2
</description>
<parameters>
-<parameter name="display">
-<parameter_description> A #GdkDisplay
+<parameter name="pixbuf">
+<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
-<parameter name="xatom">
-<parameter_description> an X atom
+<parameter name="key">
+<parameter_description> a nul-terminated string.
</parameter_description>
</parameter>
</parameters>
-<return> the corresponding #GdkAtom.
-
+<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_window_unmaximize">
+<function name="gdk_pixbuf_get_pixels">
<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 "maximized"; 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.
+Queries a pointer to the pixel data of a pixbuf.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="pixbuf">
+<parameter_description> A pixbuf.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A pointer to the pixbuf's pixel data. Please see <xref linkend="image-data"/>
+for information about how the pixel data is stored in
+memory.
+</return>
</function>
-<function name="gdk_draw_layout">
+<function name="gdk_pixbuf_get_rowstride">
<description>
-Render a #PangoLayout onto a GDK drawable
-
-If the layout's #PangoContext has a transformation matrix set, then
- x and @y specify the position of the top left corner of the
-bounding box (in device space) of the transformed layout.
+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.
-If you're using GTK+, the usual way to obtain a #PangoLayout
-is gtk_widget_create_pango_layout().
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> the drawable on which to draw string
-</parameter_description>
-</parameter>
-<parameter name="gc">
-<parameter_description> base graphics context to use
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the X position of the left of the layout (in pixels)
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> the Y position of the top of the layout (in pixels)
-</parameter_description>
-</parameter>
-<parameter name="layout">
-<parameter_description> a #PangoLayout
+<parameter name="pixbuf">
+<parameter_description> A pixbuf.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> Distance between row starts.
+</return>
</function>
-<function name="gdk_cursor_unref">
+<function name="gdk_pixbuf_get_width">
<description>
-Removes a reference from @cursor, deallocating the cursor
-if no references remain.
+Queries the width of a pixbuf.
</description>
<parameters>
-<parameter name="cursor">
-<parameter_description> a #GdkCursor
+<parameter name="pixbuf">
+<parameter_description> A pixbuf.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> Width in pixels.
+</return>
</function>
-<function name="gdk_screen_set_font_options">
+<function name="gdk_pixbuf_loader_close">
<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.
+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.
-Since: 2.10
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="loader">
+<parameter_description> A pixbuf loader.
</parameter_description>
</parameter>
-<parameter name="options">
-<parameter_description> a #cairo_font_options_t, or %NULL to unset any
-previously set default font options.
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL to ignore errors
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if all image data written so far was successfully
+ passed out via the update_area signal
+</return>
</function>
-<function name="gdk_draw_segments">
+<function name="gdk_pixbuf_loader_get_animation">
<description>
-Draws a number of unconnected lines.
+Queries the #GdkPixbufAnimation that a pixbuf loader is currently creating.
+In general it only makes sense to call this function after the "area-prepared"
+signal has been emitted by the loader. If the loader doesn't have enough
+bytes yet (hasn't emitted the "area-prepared" signal) this function will
+return %NULL.
+
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
-</parameter_description>
-</parameter>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
-</parameter_description>
-</parameter>
-<parameter name="segs">
-<parameter_description> an array of #GdkSegment structures specifying the start and
-end points of the lines to be drawn.
-</parameter_description>
-</parameter>
-<parameter name="n_segs">
-<parameter_description> the number of line segments to draw, i.e. the size of the
- segs array.
+<parameter name="loader">
+<parameter_description> A pixbuf loader
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<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_window_begin_paint_region">
+<function name="gdk_pixbuf_loader_get_format">
<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 pixmap 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.
+Obtains the available information about the format of the
+currently loading image file.
-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.
+Since: 2.2
-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().)
+</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.
-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().
+</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
+"area-prepared" 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 "static image" of the animation
+(see gdk_pixbuf_animation_get_static_image()).
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="region">
-<parameter_description> region you intend to draw to
+<parameter name="loader">
+<parameter_description> A pixbuf loader.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<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_list_visuals">
+<function name="gdk_pixbuf_loader_new">
<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.
+Creates a new pixbuf loader object.
</description>
<parameters>
</parameters>
-<return> a list of visuals; the list must be freed, but not its contents
+<return> A newly-created pixbuf loader.
</return>
</function>
-<function name="gdk_drag_drop_succeeded">
+<function name="gdk_pixbuf_loader_new_with_mime_type">
<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.
+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.
-Since: 2.6
+The list of supported mime types depends on what image loaders
+are installed, but typically "image/png", "image/jpeg", "image/gif",
+"image/tiff" and "image/x-xpixmap" 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="context">
-<parameter_description> a #GdkDragContext
+<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> %TRUE if the drop was successful.
-
+<return> A newly-created pixbuf loader.
</return>
</function>
-<function name="gdk_pixbuf_render_pixmap_and_mask_for_colormap">
+<function name="gdk_pixbuf_loader_new_with_type">
<description>
-Creates a pixmap and a mask bitmap which are returned in the @pixmap_return
-and @mask_return arguments, respectively, and renders a pixbuf and its
-corresponding tresholded alpha mask to them. This is merely a convenience
-function; applications that need to render pixbufs with dither offsets or to
-given drawables should use gdk_draw_pixbuf(), and gdk_pixbuf_render_threshold_alpha().
+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 pixmap that is created uses the #GdkColormap specified by @colormap.
-This colormap must match the colormap of the window where the pixmap
-will eventually be used or an error will result.
+The list of supported image formats depends on what image loaders
+are installed, but typically "png", "jpeg", "gif", "tiff" and
+"xpm" 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().
-If the pixbuf does not have an alpha channel, then * mask_return will be set
-to %NULL.
</description>
<parameters>
-<parameter name="pixbuf">
-<parameter_description> A pixbuf.
+<parameter name="image_type">
+<parameter_description> name of the image format to be loaded with the image
</parameter_description>
</parameter>
-<parameter name="colormap">
-<parameter_description> A #GdkColormap
+<parameter name="error">
+<parameter_description> return location for an allocated #GError, or %NULL to ignore errors
</parameter_description>
</parameter>
-<parameter name="pixmap_return">
-<parameter_description> Location to store a pointer to the created pixmap,
-or %NULL if the pixmap is not needed.
+</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="mask_return">
-<parameter_description> Location to store a pointer to the created mask,
-or %NULL if the mask is not needed.
+<parameter name="width">
+<parameter_description> The desired width of the image being loaded.
</parameter_description>
</parameter>
-<parameter name="alpha_threshold">
-<parameter_description> Threshold value for opacity values.
+<parameter name="height">
+<parameter_description> The desired height of the image being loaded.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_directfb_visual_by_format">
+<function name="gdk_pixbuf_loader_write">
<description>
-This function is specific to the DirectFB backend. It allows
-to specify a GdkVisual by @pixel_format.
-
-At startup, only those visuals that can be blitted
-hardware-accelerated are registered. By using
-gdk_directfb_visual_by_format() you can retrieve visuals that
-don't match this criteria since this function will try to create
-a new visual for the desired @pixel_format for you.
+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="pixel_format">
-<parameter_description> the pixel_format of the requested visual
+<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> a pointer to the GdkVisual or %NULL if the
-pixel_format is unsupported.
+<return> %TRUE if the write was successful, or %FALSE if the loader
+cannot parse the buffer.
</return>
</function>
-<function name="gdk_text_property_to_utf8_list">
+<function name="gdk_pixbuf_new">
<description>
-Convert a text property in the giving encoding to
-a list of UTF-8 strings.
+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="encoding">
-<parameter_description> an atom representing the encoding of the text
+<parameter name="colorspace">
+<parameter_description> Color space for image
</parameter_description>
</parameter>
-<parameter name="format">
-<parameter_description> the format of the property
+<parameter name="has_alpha">
+<parameter_description> Whether the image should have transparency information
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> the text to convert
+<parameter name="bits_per_sample">
+<parameter_description> Number of bits per color sample
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> the length of @text, in bytes
+<parameter name="width">
+<parameter_description> Width of image in pixels, must be > 0
</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 name="height">
+<parameter_description> Height of image in pixels, must be > 0
</parameter_description>
</parameter>
</parameters>
-<return> the number of strings in the resulting
-list.
+<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_unicode_to_keyval">
+<function name="gdk_pixbuf_new_from_data">
<description>
-Convert from a ISO10646 character to a key symbol.
+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="wc">
-<parameter_description> a ISO10646 encoded character
+<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 > 0
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> Height of the image in pixels, must be > 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> the corresponding GDK key symbol, if one exists.
-or, if there is no corresponding symbol,
-wc | 0x01000000
+<return> A newly-created #GdkPixbuf structure with a reference count of 1.
</return>
</function>
-<function name="gdk_x11_atom_to_xatom">
+<function name="gdk_pixbuf_new_from_file">
<description>
-Converts from a #GdkAtom to the X atom for the default GDK display
-with the same string value.
+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="atom">
-<parameter_description> A #GdkAtom
+<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> the X atom corresponding to @atom.
+<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_event_get_state">
+<function name="gdk_pixbuf_new_from_file_at_scale">
<description>
-If the event contains a "state" 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.
+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="event">
-<parameter_description> a #GdkEvent or NULL
+<parameter name="filename">
+<parameter_description> Name of file to load, in the GLib file name encoding
</parameter_description>
</parameter>
-<parameter name="state">
-<parameter_description> return location for state
+<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> %TRUE if there was a state field in the event
+<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_gc_get_colormap">
+<function name="gdk_pixbuf_new_from_file_at_size">
<description>
-Retrieves the colormap for a given GC, if it exists.
-A GC will have a colormap if the drawable for which it was created
-has a colormap, or if a colormap was set explicitely with
-gdk_gc_set_colormap.
+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="gc">
-<parameter_description> a #GdkGC
+<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> the colormap of @gc, or %NULL if @gc doesn't have one.
+<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_display_open">
+<function name="gdk_pixbuf_new_from_inline">
<description>
-Opens a display.
+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.
-Since: 2.2
+gdk-pixbuf ships with a program called <command>gdk-pixbuf-csource</command>
+which allows for conversion of #GdkPixbufs into such a inline representation.
+In almost all cases, you should pass the <option>--raw</option> flag to
+<command>gdk-pixbuf-csource</command>. A sample invocation would be:
-</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>
+<informalexample><programlisting>
+gdk-pixbuf-csource --raw --name=myimage_inline myimage.png
+</programlisting></informalexample>
-<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).
+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
+<option>--rle</option> to <command>gdk-pixbuf-csource</command>, a copy
+will be made even if @copy_pixels is %FALSE, so using this option is
+generally a bad idea.)
-If @sibling is %NULL, then this either raises (if @above is %TRUE) or
-lowers the window.
+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:
+<informalexample><programlisting>
+pixbuf = gdk_pixbuf_new_from_inline (-1, myimage_inline, FALSE, NULL);
+</programlisting></informalexample>
-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.
+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.
-Since: 2.18
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="data_length">
+<parameter_description> Length in bytes of the @data argument or -1 to
+disable length checks
</parameter_description>
</parameter>
-<parameter name="sibling">
-<parameter_description> a #GdkWindow that is a sibling of @window, or %NULL
+<parameter name="data">
+<parameter_description> Byte data containing a serialized #GdkPixdata structure
</parameter_description>
</parameter>
-<parameter name="above">
-<parameter_description> a boolean
+<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></return>
+<return> A newly-created #GdkPixbuf structure with a reference,
+count of 1, or %NULL if an error occurred.
+</return>
</function>
-<function name="gdk_x11_get_xatom_name">
+<function name="gdk_pixbuf_new_from_stream">
<description>
-Returns the name of an X atom for GDK's default display. This
-function is meant mainly for debugging, so for convenience, unlike
-<function>XAtomName()</function> and gdk_atom_name(), the result
-doesn't need to be freed. Also, this function will never return %NULL,
-even if @xatom is invalid.
+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
+%GIO_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="xatom">
-<parameter_description> an X atom for GDK's default display
+<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> name of the X atom; this string is owned by GTK+,
-so it shouldn't be modifed or freed.
+<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_display_beep">
+<function name="gdk_pixbuf_new_from_stream_async">
<description>
-Emits a short beep on @display
+Creates a new pixbuf by asynchronously loading an image from an input stream.
-Since: 2.2
+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="display">
-<parameter_description> a #GdkDisplay
+<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_keymap_get_entries_for_keycode">
+<function name="gdk_pixbuf_new_from_stream_at_scale">
<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().
+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
+%GIO_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="keymap">
-<parameter_description> a #GdkKeymap or %NULL to use the default keymap
+<parameter name="stream">
+<parameter_description> a #GInputStream to load the pixbuf from
</parameter_description>
</parameter>
-<parameter name="hardware_keycode">
-<parameter_description> a keycode
+<parameter name="width">
+<parameter_description> The width the image should have or -1 to not constrain the width
</parameter_description>
</parameter>
-<parameter name="keys">
-<parameter_description> return location for array of #GdkKeymapKey, or NULL
+<parameter name="height">
+<parameter_description> The height the image should have or -1 to not constrain the height
</parameter_description>
</parameter>
-<parameter name="keyvals">
-<parameter_description> return location for array of keyvals, or NULL
+<parameter name="preserve_aspect_ratio">
+<parameter_description> %TRUE to preserve the image's aspect ratio
</parameter_description>
</parameter>
-<parameter name="n_entries">
-<parameter_description> length of @keys and @keyvals
+<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> %TRUE if there were any entries
+<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_window_get_origin">
+<function name="gdk_pixbuf_new_from_stream_at_scale_async">
<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.)
+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="window">
-<parameter_description> a #GdkWindow
+<parameter name="stream">
+<parameter_description> a #GInputStream from which to load the pixbuf
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> return location for X coordinate
+<parameter name="width">
+<parameter_description> the width the image should have or -1 to not constrain the width
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> return location for Y coordinate
+<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> not meaningful, ignore
-</return>
+<return></return>
</function>
-<function name="gdk_window_get_window_type">
+<function name="gdk_pixbuf_new_from_stream_finish">
<description>
-Gets the type of the window. See #GdkWindowType.
+Finishes an asynchronous pixbuf creation operation started with
+gdk_pixbuf_new_from_stream_async().
+Since: 2.24
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<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> type of window
+<return> a #GdkPixbuf or %NULL on error. Free the returned
+object with g_object_unref().
+
</return>
</function>
-<function name="gdk_gc_set_clip_region">
+<function name="gdk_pixbuf_new_from_xpm_data">
<description>
-Sets the clip mask for a graphics context from a region structure.
-The clip mask is interpreted relative to the clip origin. (See
-gdk_gc_set_clip_origin()).
+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="gc">
-<parameter_description> a #GdkGC.
-</parameter_description>
-</parameter>
-<parameter name="region">
-<parameter_description> the #GdkRegion.
+<parameter name="data">
+<parameter_description> Pointer to inline XPM data.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A newly-created pixbuf with a reference count of 1.
+</return>
</function>
-<function name="gdk_colormap_alloc_colors">
+<function name="gdk_pixbuf_new_subpixbuf">
<description>
-Allocates colors from a colormap.
+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="colormap">
-<parameter_description> a #GdkColormap.
+<parameter name="src_pixbuf">
+<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
-<parameter name="colors">
-<parameter_description> The color values to allocate. On return, the pixel
-values for allocated colors will be filled in.
+<parameter name="src_x">
+<parameter_description> X coord in @src_pixbuf
</parameter_description>
</parameter>
-<parameter name="n_colors">
-<parameter_description> The number of colors in @colors.
+<parameter name="src_y">
+<parameter_description> Y coord in @src_pixbuf
</parameter_description>
</parameter>
-<parameter name="writeable">
-<parameter_description> If %TRUE, the colors are allocated writeable
-(their values can later be changed using gdk_color_change()).
-Writeable colors cannot be shared between applications.
+<parameter name="width">
+<parameter_description> width of region in @src_pixbuf
</parameter_description>
</parameter>
-<parameter name="best_match">
-<parameter_description> If %TRUE, GDK will attempt to do matching against
-existing colors if the colors cannot be allocated as requested.
+<parameter name="height">
+<parameter_description> height of region in @src_pixbuf
</parameter_description>
</parameter>
-<parameter name="success">
-<parameter_description> An array of length @ncolors. On return, this
-indicates whether the corresponding color in @colors was
-successfully allocated or not.
+</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 number of colors that were not successfully
-allocated.
+<return> The same as the @pixbuf argument.
+
</return>
</function>
-<function name="gdk_region_equal">
+<function name="gdk_pixbuf_rotate_simple">
<description>
-Finds out if the two regions are the same.
+Rotates a pixbuf by a multiple of 90 degrees, and returns the
+result in a new pixbuf.
+Since: 2.6
</description>
<parameters>
-<parameter name="region1">
-<parameter_description> a #GdkRegion
+<parameter name="src">
+<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
-<parameter name="region2">
-<parameter_description> a #GdkRegion
+<parameter name="angle">
+<parameter_description> the angle to rotate by
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @region1 and @region2 are equal.
+<return> the new #GdkPixbuf, or %NULL if not enough memory could be
+allocated for it.
+
</return>
</function>
-<function name="gdk_region_shrink">
+<function name="gdk_pixbuf_saturate_and_pixelate">
<description>
-Resizes a region by the specified amount.
-Positive values shrink the region. Negative values expand it.
+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="region">
-<parameter_description> a #GdkRegion
+<parameter name="src">
+<parameter_description> source image
</parameter_description>
</parameter>
-<parameter name="dx">
-<parameter_description> the number of pixels to shrink the region horizontally
+<parameter name="dest">
+<parameter_description> place to write modified version of @src
</parameter_description>
</parameter>
-<parameter name="dy">
-<parameter_description> the number of pixels to shrink the region vertically
+<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_event_put">
+<function name="gdk_pixbuf_save">
<description>
-Appends a copy of the given event onto the front of the event
-queue for event->any.window's display, or the default event
-queue if event->any.window is %NULL. See gdk_display_put_event().
+Saves pixbuf to a file in format @type. By default, "jpeg", "png", "ico"
+and "bmp" 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:
-</description>
-<parameters>
-<parameter name="event">
-<parameter_description> a #GdkEvent.
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
+|[
+void add_if_writable (GdkPixbufFormat *data, GSList **list)
+{
+if (gdk_pixbuf_format_is_writable (data))
+*list = g_slist_prepend (*list, data);
+}
-<function name="gdk_colormap_get_system">
-<description>
-Gets the system's default colormap for the default screen. (See
-gdk_colormap_get_system_for_screen ())
+GSList *formats = gdk_pixbuf_get_formats ();
+GSList *writable_formats = NULL;
+g_slist_foreach (formats, add_if_writable, &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.
-</description>
-<parameters>
-</parameters>
-<return> the default colormap.
-</return>
-</function>
+The variable argument list should be %NULL-terminated; if not empty,
+it should contain pairs of strings that modify the save
+parameters. For example:
+<informalexample><programlisting>
+gdk_pixbuf_save (pixbuf, handle, "jpeg", &error,
+"quality", "100", NULL);
+</programlisting></informalexample>
-<function name="gdk_window_is_destroyed">
-<description>
-Check to see if a window is destroyed..
+Currently only few parameters exist. JPEG images can be saved with a
+"quality" parameter; its value should be in the range [0,100].
+
+Text chunks can be attached to PNG images by specifying parameters of
+the form "tEXt::key", 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 "compression" parameter; it's value is in an
+integer in the range of [0,9].
+
+ICC color profiles can also be embedded into PNG and TIFF images.
+The "icc-profile" value should be the complete ICC profile encoded
+into base64.
+
+<informalexample><programlisting>
+gchar *contents;
+gchar *contents_encode;
+gsize length;
+g_file_get_contents ("/home/hughsie/.color/icc/L225W.icm", &contents, &length, NULL);
+contents_encode = g_base64_encode ((const guchar *) contents, length);
+gdk_pixbuf_save (pixbuf, handle, "png", &error,
+"icc-profile", contents_encode,
+NULL);
+</programlisting></informalexample>
+
+TIFF images recognize a "compression" 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 "depth"
+parameter. When the ICO saver is given "x_hot" and "y_hot" parameters,
+it produces a CUR instead of an ICO.
-Since: 2.18
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<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
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the window is destroyed
-
+<return> whether an error was set
</return>
</function>
-<function name="gdk_visual_get_screen">
+<function name="gdk_pixbuf_save_to_buffer">
<description>
-Gets the screen to which this visual belongs
+Saves pixbuf to a new buffer in format @type, which is currently "jpeg",
+"png", "tiff", "ico" or "bmp". 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.
-Since: 2.2
+See gdk_pixbuf_save() for more details.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="visual">
-<parameter_description> a #GdkVisual
+<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> the screen to which this visual belongs.
+<return> whether an error was set
</return>
</function>
-<function name="gdk_region_rect_equal">
+<function name="gdk_pixbuf_save_to_bufferv">
<description>
-Finds out if a regions is the same as a rectangle.
+Saves pixbuf to a new buffer in format @type, which is currently "jpeg",
+"tiff", "png", "ico" or "bmp". See gdk_pixbuf_save_to_buffer()
+for more details.
-Since: 2.18
+Since: 2.4
</description>
<parameters>
-<parameter name="region">
-<parameter_description> a #GdkRegion
+<parameter name="pixbuf">
+<parameter_description> a #GdkPixbuf.
</parameter_description>
</parameter>
-<parameter name="rectangle">
-<parameter_description> a #GdkRectangle
+<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> %TRUE if @region and @rectangle are equal.
+<return> whether an error was set
</return>
</function>
-<function name="gdk_drawable_ref">
+<function name="gdk_pixbuf_save_to_callback">
<description>
-Deprecated equivalent of calling g_object_ref() on @drawable.
-(Drawables were not objects in previous versions of GDK.)
+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.
-Deprecated: 2.0: Use g_object_ref() instead.
+Since: 2.4
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<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> the same @drawable passed in
+<return> whether an error was set
</return>
</function>
-<function name="gdk_drawable_get_visible_region">
+<function name="gdk_pixbuf_save_to_callbackv">
<description>
-Computes the region of a drawable 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.
+Saves pixbuf to a callback in format @type, which is currently "jpeg",
+"png", "tiff", "ico" or "bmp". If @error is set, %FALSE will be returned. See
+gdk_pixbuf_save_to_callback () for more details.
+Since: 2.4
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<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> a #GdkRegion. This must be freed with gdk_region_destroy()
-when you are done.
+<return> whether an error was set
+
</return>
</function>
-<function name="gdk_gc_set_background">
+<function name="gdk_pixbuf_save_to_stream">
<description>
-Sets the background color for a graphics context.
-Note that this function uses @color->pixel, use
-gdk_gc_set_rgb_bg_color() to specify the background
-color as red, green, blue components.
+Saves @pixbuf to an output stream.
+
+Supported file formats are currently "jpeg", "tiff", "png", "ico" or
+"bmp". 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 %GIO_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="gc">
-<parameter_description> a #GdkGC.
+<parameter name="pixbuf">
+<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> the new background color.
+<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></return>
+<return> %TRUE if the pixbuf was saved successfully, %FALSE if an
+error was set.
+
+</return>
</function>
-<function name="gdk_window_move_resize">
+<function name="gdk_pixbuf_save_to_stream_async">
<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().)
+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="window">
-<parameter_description> a #GdkWindow
+<parameter name="pixbuf">
+<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> new X position relative to window's parent
+<parameter name="stream">
+<parameter_description> a #GOutputStream to which to save the pixbuf
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> new Y position relative to window's parent
+<parameter name="type">
+<parameter_description> name of file format
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> new width
+<parameter name="cancellable">
+<parameter_description> optional #GCancellable object, %NULL to ignore
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> new height
+<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_cursor_new_for_display">
+<function name="gdk_pixbuf_save_to_stream_finish">
<description>
-Creates a new cursor from the set of builtin cursors.
-Some useful ones are:
-<itemizedlist>
-<listitem><para>
-<inlinegraphic format="PNG" fileref="right_ptr.png"></inlinegraphic> #GDK_RIGHT_PTR (right-facing arrow)
-</para></listitem>
-<listitem><para>
-<inlinegraphic format="PNG" fileref="crosshair.png"></inlinegraphic> #GDK_CROSSHAIR (crosshair)
-</para></listitem>
-<listitem><para>
-<inlinegraphic format="PNG" fileref="xterm.png"></inlinegraphic> #GDK_XTERM (I-beam)
-</para></listitem>
-<listitem><para>
-<inlinegraphic format="PNG" fileref="watch.png"></inlinegraphic> #GDK_WATCH (busy)
-</para></listitem>
-<listitem><para>
-<inlinegraphic format="PNG" fileref="fleur.png"></inlinegraphic> #GDK_FLEUR (for moving objects)
-</para></listitem>
-<listitem><para>
-<inlinegraphic format="PNG" fileref="hand1.png"></inlinegraphic> #GDK_HAND1 (a right-pointing hand)
-</para></listitem>
-<listitem><para>
-<inlinegraphic format="PNG" fileref="hand2.png"></inlinegraphic> #GDK_HAND2 (a left-pointing hand)
-</para></listitem>
-<listitem><para>
-<inlinegraphic format="PNG" fileref="left_side.png"></inlinegraphic> #GDK_LEFT_SIDE (resize left side)
-</para></listitem>
-<listitem><para>
-<inlinegraphic format="PNG" fileref="right_side.png"></inlinegraphic> #GDK_RIGHT_SIDE (resize right side)
-</para></listitem>
-<listitem><para>
-<inlinegraphic format="PNG" fileref="top_left_corner.png"></inlinegraphic> #GDK_TOP_LEFT_CORNER (resize northwest corner)
-</para></listitem>
-<listitem><para>
-<inlinegraphic format="PNG" fileref="top_right_corner.png"></inlinegraphic> #GDK_TOP_RIGHT_CORNER (resize northeast corner)
-</para></listitem>
-<listitem><para>
-<inlinegraphic format="PNG" fileref="bottom_left_corner.png"></inlinegraphic> #GDK_BOTTOM_LEFT_CORNER (resize southwest corner)
-</para></listitem>
-<listitem><para>
-<inlinegraphic format="PNG" fileref="bottom_right_corner.png"></inlinegraphic> #GDK_BOTTOM_RIGHT_CORNER (resize southeast corner)
-</para></listitem>
-<listitem><para>
-<inlinegraphic format="PNG" fileref="top_side.png"></inlinegraphic> #GDK_TOP_SIDE (resize top side)
-</para></listitem>
-<listitem><para>
-<inlinegraphic format="PNG" fileref="bottom_side.png"></inlinegraphic> #GDK_BOTTOM_SIDE (resize bottom side)
-</para></listitem>
-<listitem><para>
-<inlinegraphic format="PNG" fileref="sb_h_double_arrow.png"></inlinegraphic> #GDK_SB_H_DOUBLE_ARROW (move vertical splitter)
-</para></listitem>
-<listitem><para>
-<inlinegraphic format="PNG" fileref="sb_v_double_arrow.png"></inlinegraphic> #GDK_SB_V_DOUBLE_ARROW (move horizontal splitter)
-</para></listitem>
-<listitem><para>
-#GDK_BLANK_CURSOR (Blank cursor). Since 2.16
-</para></listitem>
-</itemizedlist>
+Finishes an asynchronous pixbuf save operation started with
+gdk_pixbuf_save_to_stream_async().
-Since: 2.2
+Since: 2.24
</description>
<parameters>
-<parameter name="display">
-<parameter_description> the #GdkDisplay for which the cursor will be created
+<parameter name="async_result">
+<parameter_description> a #GAsyncResult
</parameter_description>
</parameter>
-<parameter name="cursor_type">
-<parameter_description> cursor to create
+<parameter name="error">
+<parameter_description> a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkCursor
+<return> %TRUE if the pixbuf was saved successfully, %FALSE if an error was set.
</return>
</function>
-<function name="gdk_fontset_load_for_display">
+<function name="gdk_pixbuf_savev">
<description>
-Loads a fontset for use on @display.
-
-The fontset may be newly loaded or looked up in a cache.
-You should make no assumptions about the initial reference count.
+Saves pixbuf to a file in @type, which is currently "jpeg", "png", "tiff", "ico" or "bmp".
+If @error is set, %FALSE will be returned.
+See gdk_pixbuf_save () for more details.
-Since: 2.2
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="pixbuf">
+<parameter_description> a #GdkPixbuf.
</parameter_description>
</parameter>
-<parameter name="fontset_name">
-<parameter_description> a comma-separated list of XLFDs describing
-the component fonts of the fontset to load.
+<parameter name="filename">
+<parameter_description> name of file to save.
</parameter_description>
</parameter>
-</parameters>
-<return> a #GdkFont, or %NULL if the fontset could not be loaded.
-</return>
-</function>
-
-<function name="gdk_pointer_ungrab">
-<description>
-Ungrabs the pointer on the default display, if it is grabbed by this
-application.
-
-</description>
-<parameters>
-<parameter name="time_">
-<parameter_description> a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no
-timestamp is available.
+<parameter name="type">
+<parameter_description> name of file format.
</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 name="option_keys">
+<parameter_description> name of options to set, %NULL-terminated
</parameter_description>
</parameter>
-<parameter name="hint">
-<parameter_description> A hint of the function this window will have
+<parameter name="option_values">
+<parameter_description> values for named options
</parameter_description>
</parameter>
-</parameters>
-<return></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 name="error">
+<parameter_description> return location for error, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> whether cursors can have alpha channels.
-
+<return> whether an error was set
</return>
</function>
-<function name="gdk_x11_colormap_get_xdisplay">
+<function name="gdk_pixbuf_scale">
<description>
-Returns the display of a #GdkColormap.
-
-
-</description>
-<parameters>
-<parameter name="colormap">
-<parameter_description> a #GdkColormap.
-</parameter_description>
-</parameter>
-</parameters>
-<return> an Xlib <type>Display*</type>.
-</return>
-</function>
+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.
-<function name="gdk_draw_rgb_32_image_dithalign">
-<description>
-Like gdk_draw_rgb_32_image(), but allows you to specify the dither
-offsets. See gdk_draw_rgb_image_dithalign() for more details.
+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="drawable">
-<parameter_description> a #GdkDrawable
+<parameter name="src">
+<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
-<parameter name="gc">
-<parameter_description> a #GdkGC
+<parameter name="dest">
+<parameter_description> the #GdkPixbuf into which to render the results
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> X coordinate on @drawable where image should go
+<parameter name="dest_x">
+<parameter_description> the left coordinate for region to render
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> Y coordinate on @drawable where image should go
+<parameter name="dest_y">
+<parameter_description> the top coordinate for region to render
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> width of area of image to draw
+<parameter name="dest_width">
+<parameter_description> the width of the region to render
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> height of area of image to draw
+<parameter name="dest_height">
+<parameter_description> the height of the region to render
</parameter_description>
</parameter>
-<parameter name="dith">
-<parameter_description> dithering mode
+<parameter name="offset_x">
+<parameter_description> the offset in the X direction (currently rounded to an integer)
</parameter_description>
</parameter>
-<parameter name="buf">
-<parameter_description> RGB image data
+<parameter name="offset_y">
+<parameter_description> the offset in the Y direction (currently rounded to an integer)
</parameter_description>
</parameter>
-<parameter name="rowstride">
-<parameter_description> rowstride of RGB image data
+<parameter name="scale_x">
+<parameter_description> the scale factor in the X direction
</parameter_description>
</parameter>
-<parameter name="xdith">
-<parameter_description> X dither offset
+<parameter name="scale_y">
+<parameter_description> the scale factor in the Y direction
</parameter_description>
</parameter>
-<parameter name="ydith">
-<parameter_description> Y dither offset
+<parameter name="interp_type">
+<parameter_description> the interpolation type for the transformation.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_set_background">
+<function name="gdk_pixbuf_scale_simple">
<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.)
+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().
-The @color must be allocated; gdk_rgb_find_color() is the best way
-to allocate a color.
+For more complicated scaling/compositing see gdk_pixbuf_scale()
+and gdk_pixbuf_composite().
-See also gdk_window_set_back_pixmap().
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="src">
+<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> an allocated #GdkColor
+<parameter name="dest_width">
+<parameter_description> the width of destination image
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gdk_keyboard_ungrab">
-<description>
-Ungrabs the keyboard on the default display, if it is grabbed by this
-application.
-
-</description>
-<parameters>
-<parameter name="time_">
-<parameter_description> a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no
-timestamp is available.
+<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></return>
+<return> the new #GdkPixbuf, or %NULL if not enough memory could be
+allocated for it.
+</return>
</function>
-<function name="gdk_window_invalidate_region">
+<function name="gdk_pixbuf_set_option">
<description>
-Adds @region to the update area for @window. The update area is the
-region that needs to be redrawn, or "dirty region." 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.
+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.
-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.
+Since: 2.2
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="pixbuf">
+<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
-<parameter name="region">
-<parameter_description> a #GdkRegion
+<parameter name="key">
+<parameter_description> a nul-terminated string.
</parameter_description>
</parameter>
-<parameter name="invalidate_children">
-<parameter_description> %TRUE to also invalidate child windows
+<parameter name="value">
+<parameter_description> a nul-terminated string.
</parameter_description>
</parameter>
</parameters>
-<return></return>
-</function>
+<return> %TRUE on success.
-<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_window_enable_synchronized_configure">
+<function name="gdk_pixbuf_simple_anim_add_frame">
<description>
-Indicates that the application will cooperate with the window
-system in synchronizing the window repaint with the window
-manager during resizing operations. After an application calls
-this function, it must call gdk_window_configure_finished() every
-time it has finished all processing associated with a set of
-Configure events. Toplevel GTK+ windows automatically use this
-protocol.
-
-On X, calling this function makes @window participate in the
-_NET_WM_SYNC_REQUEST window manager protocol.
+Adds a new frame to @animation. The @pixbuf must
+have the dimensions specified when the animation
+was constructed.
-Since: 2.6
+Since: 2.8
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<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_pixmap_lookup_for_display">
+<function name="gdk_pixbuf_simple_anim_get_loop">
<description>
-Looks up the #GdkPixmap that wraps the given native pixmap handle.
-
-For example in the X backend, a native pixmap handle is an Xlib
-<type>XID</type>.
+Gets whether @animation should loop indefinitely when it reaches the end.
-Since: 2.2
+Since: 2.18
</description>
<parameters>
-<parameter name="display">
-<parameter_description> the #GdkDisplay associated with @anid
-</parameter_description>
-</parameter>
-<parameter name="anid">
-<parameter_description> a native pixmap handle.
+<parameter name="animation">
+<parameter_description> a #GdkPixbufSimpleAnim
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkPixmap wrapper for the native pixmap,
-or %NULL if there is none.
+<return> %TRUE if the animation loops forever, %FALSE otherwise
</return>
</function>
-<function name="gdk_window_set_back_pixmap">
+<function name="gdk_pixbuf_simple_anim_new">
<description>
-Sets the background pixmap of @window. May also be used to set a
-background of "None" on @window, by setting a background pixmap
-of %NULL.
-
-A background pixmap will be tiled, positioning the first tile at
-the origin of @window, or if @parent_relative is %TRUE, the tiling
-will be done based on the origin of the parent window (useful to
-align tiles in a parent with tiles in a child).
+Creates a new, empty animation.
-A background pixmap of %NULL means that the window will have no
-background. A window with no background will never have its
-background filled by the windowing system, instead the window will
-contain whatever pixels were already in the corresponding area of
-the display.
-
-The windowing system will normally fill a window with its background
-when the window is obscured then exposed, and when you call
-gdk_window_clear().
+Since: 2.8
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="width">
+<parameter_description> the width of the animation
</parameter_description>
</parameter>
-<parameter name="pixmap">
-<parameter_description> a #GdkPixmap, or %NULL
+<parameter name="height">
+<parameter_description> the height of the animation
</parameter_description>
</parameter>
-<parameter name="parent_relative">
-<parameter_description> whether the tiling origin is at the origin of
- window's parent
+<parameter name="rate">
+<parameter_description> the speed of the animation, in frames per second
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a newly allocated #GdkPixbufSimpleAnim
+
+</return>
</function>
-<function name="gdk_string_measure">
+<function name="gdk_pixbuf_simple_anim_set_loop">
<description>
-Determines the distance from the origin to the rightmost
-portion of a nul-terminated string when drawn. This is not the
-correct value for determining the origin of the next
-portion when drawing text in multiple pieces.
-See gdk_string_width().
+Sets whether @animation should loop indefinitely when it reaches the end.
+Since: 2.18
</description>
<parameters>
-<parameter name="font">
-<parameter_description> a #GdkFont
+<parameter name="animation">
+<parameter_description> a #GdkPixbufSimpleAnim
</parameter_description>
</parameter>
-<parameter name="string">
-<parameter_description> the nul-terminated string to measure.
+<parameter name="loop">
+<parameter_description> whether to loop the animation
</parameter_description>
</parameter>
</parameters>
-<return> the right bearing of the string in pixels.
-</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>
+<return></return>
</function>
-<function name="gdk_keymap_get_for_display">
+<function name="gdk_pixbuf_unref">
<description>
-Returns the #GdkKeymap attached to @display.
+Removes a reference from a pixbuf.
-Since: 2.2
+Deprecated: 2.0: Use g_object_unref().
</description>
<parameters>
-<parameter name="display">
-<parameter_description> the #GdkDisplay.
+<parameter name="pixbuf">
+<parameter_description> A pixbuf.
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkKeymap attached to @display.
-</return>
+<return></return>
</function>
-<function name="gdk_pixbuf_render_threshold_alpha">
+<function name="gdk_pixdata_deserialize">
<description>
-Takes the opacity values in a rectangular portion of a pixbuf and thresholds
-them to produce a bi-level alpha mask that can be used as a clipping mask for
-a drawable.
+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_CORRUPT_IMAGE
+or %GDK_PIXBUF_ERROR_UNKNOWN_TYPE.
</description>
<parameters>
-<parameter name="pixbuf">
-<parameter_description> A pixbuf.
-</parameter_description>
-</parameter>
-<parameter name="bitmap">
-<parameter_description> Bitmap where the bilevel mask will be painted to.
-</parameter_description>
-</parameter>
-<parameter name="src_x">
-<parameter_description> Source X coordinate.
-</parameter_description>
-</parameter>
-<parameter name="src_y">
-<parameter_description> source Y coordinate.
-</parameter_description>
-</parameter>
-<parameter name="dest_x">
-<parameter_description> Destination X coordinate.
-</parameter_description>
-</parameter>
-<parameter name="dest_y">
-<parameter_description> Destination Y coordinate.
+<parameter name="pixdata">
+<parameter_description> a #GdkPixdata structure to be filled in.
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> Width of region to threshold, or -1 to use pixbuf width
+<parameter name="stream_length">
+<parameter_description> length of the stream used for deserialization.
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> Height of region to threshold, or -1 to use pixbuf height
+<parameter name="stream">
+<parameter_description> stream of bytes containing a serialized #GdkPixdata structure.
</parameter_description>
</parameter>
-<parameter name="alpha_threshold">
-<parameter_description> Opacity values below this will be painted as zero; all
-other values will be painted as one.
+<parameter name="error">
+<parameter_description> #GError location to indicate failures (maybe %NULL to ignore errors).
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> Upon successful deserialization %TRUE is returned,
+%FALSE otherwise.
+</return>
</function>
-<function name="gdk_draw_layout_line_with_colors">
+<function name="gdk_pixdata_from_pixbuf">
<description>
-Render a #PangoLayoutLine onto a #GdkDrawable, overriding the
-layout's normal colors with @foreground and/or @background.
- foreground and @background need not be allocated.
+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.
-If the layout's #PangoContext has a transformation matrix set, then
- x and @y specify the position of the left edge of the baseline
-(left is in before-tranform user coordinates) in after-transform
-device coordinates.
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> the drawable on which to draw the line
-</parameter_description>
-</parameter>
-<parameter name="gc">
-<parameter_description> base graphics to use
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x position of start of string (in pixels)
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> the y position of baseline (in pixels)
-</parameter_description>
-</parameter>
-<parameter name="line">
-<parameter_description> a #PangoLayoutLine
+<parameter name="pixdata">
+<parameter_description> a #GdkPixdata to fill.
</parameter_description>
</parameter>
-<parameter name="foreground">
-<parameter_description> foreground override color, or %NULL for none
+<parameter name="pixbuf">
+<parameter_description> the data to fill @pixdata with.
</parameter_description>
</parameter>
-<parameter name="background">
-<parameter_description> background override color, or %NULL for none
+<parameter name="use_rle">
+<parameter_description> whether to use run-length encoding for the pixel data.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<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_drawable_unref">
+<function name="gdk_pixdata_serialize">
<description>
-Deprecated equivalent of calling g_object_unref() on @drawable.
+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.
-Deprecated: 2.0: Use g_object_unref() instead.
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<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></return>
+<return> A newly-allocated string containing the serialized
+#GdkPixdata structure.
+</return>
</function>
-<function name="gdk_pixmap_foreign_new_for_display">
+<function name="gdk_pixdata_to_csource">
<description>
-Wraps a native pixmap in a #GdkPixmap.
-This may fail if the pixmap has been destroyed.
+Generates C source code suitable for compiling images directly
+into programs.
-For example in the X backend, a native pixmap handle is an Xlib
-<type>XID</type>.
+gdk-pixbuf ships with a program called <command>gdk-pixbuf-csource</command>
+which offers a command line interface to this function.
-Since: 2.2
</description>
<parameters>
-<parameter name="display">
-<parameter_description> The #GdkDisplay where @anid is located.
+<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="anid">
-<parameter_description> a native pixmap handle.
+<parameter name="dump_type">
+<parameter_description> a #GdkPixdataDumpType determining the kind of C
+source to be generated.
</parameter_description>
</parameter>
</parameters>
-<return> the newly-created #GdkPixmap wrapper for the
-native pixmap or %NULL if the pixmap has been destroyed.
-
+<return> a newly-allocated string containing the C source form
+of @pixdata.
</return>
</function>
-<function name="gdk_image_set_colormap">
+<function name="gdk_pointer_grab">
<description>
-Sets the colormap for the image to the given colormap. Normally
-there's no need to use this function, images are created with the
-correct colormap if you get the image from a drawable. If you
-create the image from scratch, use the colormap of the drawable you
-intend to render the image to.
+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="image">
-<parameter_description> a #GdkImage
+<parameter name="window">
+<parameter_description> the #GdkWindow which will own the grab (the grab window).
</parameter_description>
</parameter>
-<parameter name="colormap">
-<parameter_description> a #GdkColormap
+<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>
-</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 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="rectangle">
-<parameter_description> rectangle you intend to draw to
+<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></return>
+<return> %GDK_GRAB_SUCCESS if the grab was successful.
+
+</return>
</function>
-<function name="gdk_cursor_get_display">
+<function name="gdk_pointer_is_grabbed">
<description>
-Returns the display on which the #GdkCursor is defined.
+Returns %TRUE if the pointer on the default display is currently
+grabbed by this application.
-Since: 2.2
+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>
-<parameter name="cursor">
-<parameter_description> a #GdkCursor.
-</parameter_description>
-</parameter>
</parameters>
-<return> the #GdkDisplay associated to @cursor
+<return> %TRUE if the pointer is currently grabbed by this application.
</return>
</function>
-<function name="gdk_visual_get_best_with_depth">
+<function name="gdk_pointer_ungrab">
<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.
+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="depth">
-<parameter_description> a bit depth
+<parameter name="time_">
+<parameter_description> a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no
+timestamp is available.
</parameter_description>
</parameter>
</parameters>
-<return> best visual for the given depth
-</return>
+<return></return>
</function>
-<function name="gdk_x11_display_grab">
+<function name="gdk_property_change">
<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
+Changes the contents of a property on a window.
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<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 <literal>guchar *</literal>
+<literal>gushort *</literal>, or <literal>gulong *</literal>,
+depending on @format), cast to a <literal>guchar *</literal>.
+</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_screen_make_display_name">
+<function name="gdk_property_delete">
<description>
-Determines the name to pass to gdk_display_open() to get
-a #GdkDisplay with this screen as the default screen.
-
-Since: 2.2
+Deletes a property from a window.
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="property">
+<parameter_description> the property to delete
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string, free with g_free()
-
-</return>
+<return></return>
</function>
-<function name="gdk_utf8_to_compound_text">
+<function name="gdk_property_get">
<description>
-Convert from UTF-8 to compound text.
+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.
+
+<note>
+<para>
+The XGetWindowProperty() function that gdk_property_get()
+uses has a very confusing and complicated set of semantics.
+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.
+</para>
+</note>
</description>
<parameters>
-<parameter name="str">
-<parameter_description> a UTF-8 string
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="encoding">
-<parameter_description> location to store resulting encoding
+<parameter name="property">
+<parameter_description> the property to retrieve
</parameter_description>
</parameter>
-<parameter name="format">
-<parameter_description> location to store format of the result
+<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="ctext">
-<parameter_description> location to store the data of the result
+<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> location to store the length of the data
-stored in @ctext
+<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 the conversion succeeded, otherwise
-false.
+<return> %TRUE if data was successfully received and stored
+in @data, otherwise %FALSE.
</return>
</function>
-<function name="gdk_font_get_display">
+<function name="gdk_query_depths">
<description>
-Returns the #GdkDisplay for @font.
+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.
-Since: 2.2
+The array returned by this function should not be freed.
</description>
<parameters>
-<parameter name="font">
-<parameter_description> the #GdkFont.
+<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> the corresponding #GdkDisplay.
-
-</return>
+<return></return>
</function>
-<function name="gdk_x11_gc_get_xgc">
+<function name="gdk_query_visual_types">
<description>
-Returns the X GC of a #GdkGC.
+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="gc">
-<parameter_description> a #GdkGC.
+<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> an Xlib <type>GC</type>.
-</return>
+<return></return>
</function>
-<function name="gdk_event_free">
+<function name="gdk_rectangle_intersect">
<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_get_graphics_expose() and gdk_event_copy().
+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="event">
-<parameter_description> a #GdkEvent.
+<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></return>
+<return> %TRUE if the rectangles intersect.
+</return>
</function>
-<function name="gdk_window_set_focus_on_map">
+<function name="gdk_rectangle_union">
<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
+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="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="src1">
+<parameter_description> a #GdkRectangle
</parameter_description>
</parameter>
-<parameter name="focus_on_map">
-<parameter_description> %TRUE if the window should receive input focus when mapped
+<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_display_pointer_is_grabbed">
+<function name="gdk_rgba_copy">
<description>
-Test if the pointer is grabbed.
+Makes a copy of a #GdkRGBA structure.
-Since: 2.2
+The result must be freed through gdk_rgba_free().
+
+Since: 3.0
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="rgba">
+<parameter_description> a #GdkRGBA
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if an active X pointer grab is in effect
+<return> A newly allocated #GdkRGBA, with the same contents as @rgba
</return>
</function>
-<function name="gdk_screen_get_root_window">
+<function name="gdk_rgba_equal">
<description>
-Gets the root window of @screen.
+Compares two RGBA colors.
-Since: 2.2
+Since: 3.0
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="p1">
+<parameter_description> a #GdkRGBA pointer
+</parameter_description>
+</parameter>
+<parameter name="p2">
+<parameter_description> another #GdkRGBA pointer
</parameter_description>
</parameter>
</parameters>
-<return> the root window
+<return> %TRUE if the two colors compare equal
</return>
</function>
-<function name="gdk_event_new">
+<function name="gdk_rgba_free">
<description>
-Creates a new event of the given type. All fields are set to 0.
+Frees a #GdkRGBA struct created with gdk_rgba_copy()
-Since: 2.2
+Since: 3.0
</description>
<parameters>
-<parameter name="type">
-<parameter_description> a #GdkEventType
+<parameter name="rgba">
+<parameter_description> a #GdkRGBA
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated #GdkEvent. The returned #GdkEvent
-should be freed with gdk_event_free().
-
-</return>
+<return></return>
</function>
-<function name="gdk_region_empty">
+<function name="gdk_rgba_hash">
<description>
-Finds out if the #GdkRegion is empty.
+A hash function suitable for using for a hash
+table that stores #GdkRGBAs.
+Since: 3.0
</description>
<parameters>
-<parameter name="region">
-<parameter_description> a #GdkRegion
+<parameter name="p">
+<parameter_description> a #GdkRGBA pointer
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @region is empty.
+<return> The hash value for @p
+
</return>
</function>
-<function name="gdk_screen_get_monitor_width_mm">
+<function name="gdk_rgba_parse">
<description>
-Gets the width in millimeters of the specified monitor, if available.
+Parses a textual representation of a color, filling in
+the <structfield>red</structfield>, <structfield>green</structfield>,
+<structfield>blue</structfield> and <structfield>alpha</structfield>
+fields of the @rgba struct.
-Since: 2.14
+The string can be either one of:
+<itemizedlist>
+<listitem>
+A standard name (Taken from the X11 rgb.txt file).
+</listitem>
+<listitem>
+A hex value in the form '#rgb' '#rrggbb' '#rrrgggbbb' or '#rrrrggggbbbb'
+</listitem>
+<listitem>
+A RGB color in the form 'rgb(r,g,b)' (In this case the color will
+have full opacity)
+</listitem>
+<listitem>
+A RGBA color in the form 'rgba(r,g,b,a)'
+</listitem>
+</itemizedlist>
+
+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="screen">
-<parameter_description> a #GdkScreen
+<parameter name="rgba">
+<parameter_description> the #GdkRGBA struct to fill in
</parameter_description>
</parameter>
-<parameter name="monitor_num">
-<parameter_description> number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
+<parameter name="spec">
+<parameter_description> the string specifying the color
</parameter_description>
</parameter>
</parameters>
-<return> the width of the monitor, or -1 if not available
+<return> %TRUE if the parsing succeeded
</return>
</function>
-<function name="gdk_visual_get_best_with_type">
+<function name="gdk_rgba_to_string">
<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
+Returns a textual specification of @rgba in the form
+<literal>rgb (r, g, b)</literal> or
+<literal>rgba (r, g, b, a)</literal>,
+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="visual_type">
-<parameter_description> a visual type
+<parameter name="rgba">
+<parameter_description> a #GdkRGBA
</parameter_description>
</parameter>
</parameters>
-<return> best visual of the given type
+<return> A newly allocated text string
+
</return>
</function>
-<function name="gdk_font_from_description">
+<function name="gdk_screen_get_active_window">
<description>
-Load a #GdkFont based on a Pango font description. This font will
-only be an approximation of the Pango font, and
-internationalization will not be handled correctly. This function
-should only be used for legacy code that cannot be easily converted
-to use Pango. Using Pango directly will produce better results.
+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 <ulink
+url="http://www.freedesktop.org/Standards/wm-spec">Extended Window
+Manager Hints</ulink>. If there is no currently currently active
+window, or the window manager does not support the
+_NET_ACTIVE_WINDOW hint, this function returns %NULL.
-</description>
-<parameters>
-<parameter name="font_desc">
-<parameter_description> a #PangoFontDescription.
-</parameter_description>
-</parameter>
-</parameters>
-<return> the newly loaded font, or %NULL if the font
-cannot be loaded.
-</return>
-</function>
+On other platforms, this function may return %NULL, depending on whether
+it is implementable on that platform.
-<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().
+The returned window should be unrefed using g_object_unref() when
+no longer needed.
+Since: 2.10
</description>
<parameters>
-<parameter name="keymap">
-<parameter_description> a #GdkKeymap, or %NULL to use the default keymap
-</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 name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if keys were found and returned
+<return> the currently active window, or %NULL.
+
</return>
</function>
-<function name="gdk_x11_colormap_foreign_new">
+<function name="gdk_screen_get_default">
<description>
-If xcolormap refers to a colormap previously known to GTK+,
-returns a new reference to the existing #GdkColormap object,
-otherwise creates a new GdkColormap object and returns that
+Gets the default screen for the default display. (See
+gdk_display_get_default ()).
Since: 2.2
</description>
<parameters>
-<parameter name="visual">
-<parameter_description> a #GdkVisual
-</parameter_description>
-</parameter>
-<parameter name="xcolormap">
-<parameter_description> The XID of a colormap with visual @visual
-</parameter_description>
-</parameter>
</parameters>
-<return> the #GdkColormap object for @xcolormap.
-Free with g_object_unref(). Note that for colormap created
-with gdk_x11_colormap_foreign_new(), unref'ing the last
-reference to the object will only free the #GdkColoramp
-object and not call XFreeColormap()
+<return> a #GdkScreen, or %NULL if there is no default display.
</return>
</function>
-<function name="gdk_color_equal">
+<function name="gdk_screen_get_display">
<description>
-Compares two colors.
+Gets the display to which the @screen belongs.
+Since: 2.2
</description>
<parameters>
-<parameter name="colora">
-<parameter_description> a #GdkColor.
-</parameter_description>
-</parameter>
-<parameter name="colorb">
-<parameter_description> another #GdkColor.
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the two colors compare equal
+<return> the display to which @screen belongs
+
</return>
</function>
-<function name="gdk_window_set_urgency_hint">
+<function name="gdk_screen_get_font_options">
<description>
-Toggles whether a window needs the user's
-urgent attention.
+Gets any options previously set with gdk_screen_set_font_options().
-Since: 2.8
+Since: 2.10
</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 name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the current font options, or %NULL if no default
+font options have been set.
+
+</return>
</function>
-<function name="gdk_cairo_rectangle">
+<function name="gdk_screen_get_height">
<description>
-Adds the given rectangle to the current path of @cr.
+Gets the height of @screen in pixels
-Since: 2.8
+Since: 2.2
</description>
<parameters>
-<parameter name="cr">
-<parameter_description> a #cairo_t
-</parameter_description>
-</parameter>
-<parameter name="rectangle">
-<parameter_description> a #GdkRectangle
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the height of @screen in pixels.
+
+</return>
</function>
-<function name="gdk_cursor_new">
+<function name="gdk_screen_get_height_mm">
<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.
+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="cursor_type">
-<parameter_description> cursor to create
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkCursor
+<return> the heigth of @screen in millimeters.
+
</return>
</function>
-<function name="gdk_rgb_find_color">
+<function name="gdk_screen_get_monitor_at_point">
<description>
- colormap should be the colormap for the graphics context and
-drawable you're using to draw. If you're drawing to a #GtkWidget,
-call gtk_widget_get_colormap().
-
- color should have its %red, %green, and %blue fields initialized;
-gdk_rgb_find_color() will fill in the %pixel field with the best
-matching pixel from a color cube. The color is then ready to be
-used for drawing, e.g. you can call gdk_gc_set_foreground() which
-expects %pixel to be initialized.
-
-In many cases, you can avoid this whole issue by calling
-gdk_gc_set_rgb_fg_color() or gdk_gc_set_rgb_bg_color(), which
-do not expect %pixel to be initialized in advance. If you use those
-functions, there's no need for gdk_rgb_find_color().
+Returns the monitor number in which the point (@x,@y) is located.
+Since: 2.2
</description>
<parameters>
-<parameter name="colormap">
-<parameter_description> a #GdkColormap
+<parameter name="screen">
+<parameter_description> a #GdkScreen.
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> a #GdkColor
+<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></return>
+<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="gdkx_visual_get">
+<function name="gdk_screen_get_monitor_at_window">
<description>
-Returns a #GdkVisual corresponding to a X visual.
+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="xvisualid">
-<parameter_description> a X visual id.
+<parameter name="screen">
+<parameter_description> a #GdkScreen.
+</parameter_description>
+</parameter>
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkVisual.
+<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_x11_register_standard_event_type">
+<function name="gdk_screen_get_monitor_geometry">
<description>
-Registers interest in receiving extension events with type codes
-between @event_base and <literal>event_base + n_events - 1</literal>.
-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.
+Retrieves the #GdkRectangle representing the size and position of
+the individual monitor within the entire screen area.
-This function should only be needed in unusual circumstances, e.g.
-when filtering XInput extension events on the root window.
+Note that the size of the entire screen area can be retrieved via
+gdk_screen_get_width() and gdk_screen_get_height().
-Since: 2.4
+Since: 2.2
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
-<parameter name="event_base">
-<parameter_description> first event type code to register
+<parameter name="monitor_num">
+<parameter_description> the monitor number, between 0 and gdk_screen_get_n_monitors (screen)
</parameter_description>
</parameter>
-<parameter name="n_events">
-<parameter_description> number of event type codes to register
+<parameter name="dest">
+<parameter_description> a #GdkRectangle to be filled with the monitor geometry
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_cairo_set_source_color">
+<function name="gdk_screen_get_monitor_height_mm">
<description>
-Sets the specified #GdkColor as the source color of @cr.
+Gets the height in millimeters of the specified monitor.
-Since: 2.8
+Since: 2.14
</description>
<parameters>
-<parameter name="cr">
-<parameter_description> a #cairo_t
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> a #GdkColor
+<parameter name="monitor_num">
+<parameter_description> number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the height of the monitor, or -1 if not available
+
+</return>
</function>
-<function name="gdk_region_union">
+<function name="gdk_screen_get_monitor_plug_name">
<description>
-Sets the area of @source1 to the union of the areas of @source1 and
- source2 The resulting area is the set of pixels contained in
-either @source1 or @source2.
+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="source1">
-<parameter_description> a #GdkRegion
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
-<parameter name="source2">
-<parameter_description> a #GdkRegion
+<parameter name="monitor_num">
+<parameter_description> number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
</parameter_description>
</parameter>
</parameters>
-<return></return>
-</function>
-
-<function name="gdk_devices_list">
-<description>
-Returns the list of available input devices for the default display.
-The list is statically allocated and should not be freed.
-
+<return> a newly-allocated string containing the name of the monitor,
+or %NULL if the name cannot be determined
-</description>
-<parameters>
-</parameters>
-<return> a list of #GdkDevice
</return>
</function>
-<function name="gdk_draw_points">
+<function name="gdk_screen_get_monitor_width_mm">
<description>
-Draws a number of points, using the foreground color and other
-attributes of the #GdkGC.
+Gets the width in millimeters of the specified monitor, if available.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
-</parameter_description>
-</parameter>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
-</parameter_description>
-</parameter>
-<parameter name="points">
-<parameter_description> an array of #GdkPoint structures.
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
-<parameter name="n_points">
-<parameter_description> the number of points to be drawn.
+<parameter name="monitor_num">
+<parameter_description> number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the width of the monitor, or -1 if not available
+
+</return>
</function>
-<function name="gdk_x11_drawable_get_xid">
+<function name="gdk_screen_get_n_monitors">
<description>
-Returns the X resource (window or pixmap) belonging to a #GdkDrawable.
+Returns the number of monitors which @screen consists of.
+Since: 2.2
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable.
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return> the ID of @drawable's X resource.
+<return> number of monitors which @screen consists of
+
</return>
</function>
-<function name="gdk_pixbuf_get_from_image">
+<function name="gdk_screen_get_number">
<description>
-Same as gdk_pixbuf_get_from_drawable() but gets the pixbuf from
-an image.
+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="dest">
-<parameter_description> Destination pixbuf, or %NULL if a new pixbuf should be created.
-</parameter_description>
-</parameter>
-<parameter name="src">
-<parameter_description> Source #GdkImage.
-</parameter_description>
-</parameter>
-<parameter name="cmap">
-<parameter_description> A colormap, or %NULL to use the one for @src
-</parameter_description>
-</parameter>
-<parameter name="src_x">
-<parameter_description> Source X coordinate within drawable.
-</parameter_description>
-</parameter>
-<parameter name="src_y">
-<parameter_description> Source Y coordinate within drawable.
-</parameter_description>
-</parameter>
-<parameter name="dest_x">
-<parameter_description> Destination X coordinate in pixbuf, or 0 if @dest is NULL.
-</parameter_description>
-</parameter>
-<parameter name="dest_y">
-<parameter_description> Destination Y coordinate in pixbuf, or 0 if @dest is NULL.
-</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 name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return> @dest, newly-created pixbuf if @dest was %NULL, %NULL on error
+<return> the index
+
</return>
</function>
-<function name="gdk_image_new_bitmap">
+<function name="gdk_screen_get_primary_monitor">
<description>
-Creates a new #GdkImage with a depth of 1 from the given data.
-<warning><para>THIS FUNCTION IS INCREDIBLY BROKEN. The passed-in data must
-be allocated by malloc() (NOT g_malloc()) and will be freed when the
-image is freed.</para></warning>
+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="visual">
-<parameter_description> the #GdkVisual to use for the image.
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> the pixel data.
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> the width of the image in pixels.
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> the height of the image in pixels.
+<parameter name="screen">
+<parameter_description> a #GdkScreen.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkImage.
+<return> An integer index for the primary monitor, or 0 if none is configured.
+
</return>
</function>
-<function name="gdk_display_list_devices">
+<function name="gdk_screen_get_resolution">
<description>
-Returns the list of available input devices attached to @display.
-The list is statically allocated and should not be freed.
+Gets the resolution for font handling on the screen; see
+gdk_screen_set_resolution() for full details.
-Since: 2.2
+Since: 2.10
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return> a list of #GdkDevice
+<return> the current resolution, or -1 if no resolution
+has been set.
</return>
</function>
-<function name="gdk_visual_get_best_type">
+<function name="gdk_screen_get_rgba_visual">
<description>
-Return the best available visual type for the default GDK screen.
+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> best visual type
+<return> a visual to use for windows with an
+alpha channel or %NULL if the capability is not available.
+
</return>
</function>
-<function name="gdk_event_get_root_coords">
+<function name="gdk_screen_get_root_window">
<description>
-Extract the root window relative x/y coordinates from an event.
+Gets the root window of @screen.
+Since: 2.2
</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 name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the event delivered root window coordinates
+<return> the root window
+
</return>
</function>
-<function name="gdk_window_get_root_origin">
+<function name="gdk_screen_get_setting">
<description>
-Obtains the top-left corner of the window manager frame in root
-window coordinates.
+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="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="screen">
+<parameter_description> the #GdkScreen where the setting is located
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> return location for X position of window frame
+<parameter name="name">
+<parameter_description> the name of the setting
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> return location for Y position of window frame
+<parameter name="value">
+<parameter_description> location to store the value of the setting
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the setting existed and a value was stored
+in @value, %FALSE otherwise.
+
+</return>
</function>
-<function name="gdk_window_process_updates">
+<function name="gdk_screen_get_system_visual">
<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.
+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="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="update_children">
-<parameter_description> whether to also process updates for child windows
+<parameter name="screen">
+<parameter_description> a #GdkScreen.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the system visual
+
+</return>
</function>
-<function name="gdk_font_from_description_for_display">
+<function name="gdk_screen_get_toplevel_windows">
<description>
-Loads a #GdkFont based on a Pango font description for use on @display.
-This font will only be an approximation of the Pango font, and
-internationalization will not be handled correctly. This function
-should only be used for legacy code that cannot be easily converted
-to use Pango. Using Pango directly will produce better results.
+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="display">
-<parameter_description> a #GdkDisplay
-</parameter_description>
-</parameter>
-<parameter name="font_desc">
-<parameter_description> a #PangoFontDescription.
+<parameter name="screen">
+<parameter_description> The #GdkScreen where the toplevels are located.
</parameter_description>
</parameter>
</parameters>
-<return> the newly loaded font, or %NULL if the font
-cannot be loaded.
+<return>
+list of toplevel windows, free with g_list_free()
</return>
</function>
-<function name="gdk_draw_polygon">
+<function name="gdk_screen_get_width">
<description>
-Draws an outlined or filled polygon.
+Gets the width of @screen in pixels
+
+Since: 2.2
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
-</parameter_description>
-</parameter>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
-</parameter_description>
-</parameter>
-<parameter name="filled">
-<parameter_description> %TRUE if the polygon should be filled. The polygon is closed
-automatically, connecting the last point to the first point if
-necessary.
-</parameter_description>
-</parameter>
-<parameter name="points">
-<parameter_description> an array of #GdkPoint structures specifying the points making
-up the polygon.
-</parameter_description>
-</parameter>
-<parameter name="n_points">
-<parameter_description> the number of points.
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the width of @screen in pixels.
+
+</return>
</function>
-<function name="gdk_window_peek_children">
+<function name="gdk_screen_get_width_mm">
<description>
-Like gdk_window_get_children(), but does not copy the list of
-children, so the list does not need to be freed.
+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="window">
-<parameter_description> a #GdkWindow
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return> a reference to the list of child windows in @window
+<return> the width of @screen in millimeters.
+
</return>
</function>
-<function name="gdk_window_set_icon">
+<function name="gdk_screen_get_window_stack">
<description>
-Sets the icon of @window as a pixmap or window. If using GTK+, investigate
-gtk_window_set_default_icon_list() first, and then gtk_window_set_icon_list()
-and gtk_window_set_icon(). If those don't meet your needs, look at
-gdk_window_set_icon_list(). Only if all those are too high-level do you
-want to fall back to gdk_window_set_icon().
+Returns a #GList of #GdkWindow<!-- -->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 <ulink
+url="http://www.freedesktop.org/Standards/wm-spec">Extended Window
+Manager Hints</ulink>. If the window manager does not support the
+_NET_CLIENT_LIST_STACKING hint, this function returns %NULL.
-</description>
-<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="icon_window">
-<parameter_description> a #GdkWindow to use for the icon, or %NULL to unset
-</parameter_description>
-</parameter>
-<parameter name="pixmap">
-<parameter_description> a #GdkPixmap to use as the icon, or %NULL to unset
-</parameter_description>
-</parameter>
-<parameter name="mask">
-<parameter_description> a 1-bit pixmap (#GdkBitmap) to use as mask for @pixmap, or %NULL to have none
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
+On other platforms, this function may return %NULL, depending on whether
+it is implementable on that platform.
-<function name="gdk_drawable_get_data">
-<description>
-Equivalent to g_object_get_data(); the #GObject variant should be
-used instead.
+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="drawable">
-<parameter_description> a #GdkDrawable
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> name the data was stored under
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return> the data stored at @key
+<return>
+a list of #GdkWindow<!-- -->s for the current window stack,
+or %NULL.
+
</return>
</function>
-<function name="gdk_beep">
+<function name="gdk_screen_height">
<description>
-Emits a short beep on the default display.
+Returns the height of the default screen in pixels.
+
</description>
<parameters>
</parameters>
-<return></return>
+<return> the height of the default screen in pixels.
+</return>
</function>
-<function name="gdk_fontset_load">
+<function name="gdk_screen_height_mm">
<description>
-Loads a fontset.
-
-The fontset may be newly loaded or looked up in a cache.
-You should make no assumptions about the initial reference count.
+Returns the height of the default screen in millimeters.
+Note that on many X servers this value will not be correct.
</description>
<parameters>
-<parameter name="fontset_name">
-<parameter_description> a comma-separated list of XLFDs describing
-the component fonts of the fontset to load.
-</parameter_description>
-</parameter>
</parameters>
-<return> a #GdkFont, or %NULL if the fontset could not be loaded.
+<return> the height of the default screen in millimeters,
+though it is not always correct.
</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 "fullscreen"; 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_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_screen_get_active_window">
+<function name="gdk_screen_is_composited">
<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 <ulink
-url="http://www.freedesktop.org/Standards/wm-spec">Extended Window
-Manager Hints</ulink>. 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.
+Returns whether windows with an RGBA visual can reasonably
+be expected to have their alpha channel drawn correctly on
+the screen.
-The returned window should be unrefed using g_object_unref() when
-no longer needed.
+On X11 this function returns whether a compositing manager is
+compositing @screen.
Since: 2.10
@@ -9246,109 +8746,86 @@ Since: 2.10
</parameter_description>
</parameter>
</parameters>
-<return> the currently active window, or %NULL.
+<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_color_alloc">
+<function name="gdk_screen_list_visuals">
<description>
-Allocates a single color from a colormap.
+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.
-Deprecated: 2.2: Use gdk_colormap_alloc_color() instead.
+Since: 2.2
</description>
<parameters>
-<parameter name="colormap">
-<parameter_description> a #GdkColormap.
-</parameter_description>
-</parameter>
-<parameter name="color">
-<parameter_description> The color to allocate. On return, the
-<structfield>pixel</structfield> field will be filled in.
+<parameter name="screen">
+<parameter_description> the relevant #GdkScreen.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the allocation succeeded.
+<return>
+a list of visuals; the list must be freed, but not its contents
</return>
</function>
-<function name="gdk_utf8_to_compound_text_for_display">
+<function name="gdk_screen_make_display_name">
<description>
-Converts from UTF-8 to compound text.
+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="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 name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the conversion succeeded, otherwise
-%FALSE.
+<return> a newly allocated string, free with g_free()
</return>
</function>
-<function name="gdk_input_add">
+<function name="gdk_screen_set_font_options">
<description>
-Establish a callback when a condition becomes true on
-a file descriptor.
+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.
-Deprecated: 2.14: Use g_io_add_watch() on a #GIOChannel
+Since: 2.10
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a file descriptor.
-</parameter_description>
-</parameter>
-<parameter name="condition">
-<parameter_description> the condition.
-</parameter_description>
-</parameter>
-<parameter name="function">
-<parameter_description> the callback function.
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> callback data passed to @function.
+<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> a tag that can later be used as an argument to
-gdk_input_remove().
-
-</return>
+<return></return>
</function>
-<function name="gdk_screen_get_font_options">
+<function name="gdk_screen_set_resolution">
<description>
-Gets any options previously set with gdk_screen_set_font_options().
+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
@@ -9358,542 +8835,1316 @@ Since: 2.10
<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_rgb_colormap">
-<description>
-Gets the preferred colormap for rendering image data on @screen.
-Not a very useful function; historically, GDK could only render RGB
-image data to one colormap and visual, but in the current version
-it can render to any colormap and visual. So there's no need to
-call this function.
-
-Since: 2.2
-
-</description>
-<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen.
+<parameter name="dpi">
+<parameter_description> the resolution in "dots per inch". (Physical inches aren't actually
+involved; the terminology is conventional.)
</parameter_description>
</parameter>
</parameters>
-<return> the preferred colormap
-
-</return>
+<return></return>
</function>
-<function name="gdk_window_remove_redirection">
+<function name="gdk_screen_width">
<description>
-Removes any active redirection started by
-gdk_window_redirect_to_drawable().
+Returns the width of the default screen in pixels.
-Since: 2.14
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> the width of the default screen in pixels.
+</return>
</function>
-<function name="gdk_display_open_default_libgtk_only">
+<function name="gdk_screen_width_mm">
<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.
+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 default display, if it could be opened,
-otherwise %NULL.
+<return> the width of the default screen in millimeters,
+though it is not always correct.
</return>
</function>
-<function name="gdk_visual_get_best">
+<function name="gdk_selection_owner_get">
<description>
-Get the visual with the most available colors for the default
-GDK screen. The return value should not be freed.
+Determines the owner of the given selection.
</description>
<parameters>
+<parameter name="selection">
+<parameter_description> an atom indentifying a selection.
+</parameter_description>
+</parameter>
</parameters>
-<return> best visual
+<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_window_set_skip_taskbar_hint">
+<function name="gdk_selection_owner_get_for_display">
<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 <emphasis>not</emphasis> be called in addition,
-instead you should allow the window to be treated according to
-standard policy for its semantic type.
+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="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="skips_taskbar">
-<parameter_description> %TRUE to skip the taskbar
+<parameter name="selection">
+<parameter_description> an atom indentifying a selection
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<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_window_set_geometry_hints">
+<function name="gdk_selection_owner_set">
<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.
+Sets the owner of the given selection.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<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="geometry">
-<parameter_description> geometry hints
+<parameter name="selection">
+<parameter_description> an atom identifying a selection.
</parameter_description>
</parameter>
-<parameter name="geom_mask">
-<parameter_description> bitmask indicating fields of @geometry to pay attention to
+<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></return>
+<return> %TRUE if the selection owner was successfully
+changed to @owner, otherwise %FALSE.
+</return>
</function>
-<function name="gdk_display_get_pointer">
+<function name="gdk_selection_owner_set_for_display">
<description>
-Gets the current location of the pointer and the current modifier
-mask for a given display.
+Sets the #GdkWindow @owner as the current owner of the selection @selection.
Since: 2.2
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> the #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="screen">
-<parameter_description> location to store the screen that the
-cursor is on, or %NULL.
+<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="x">
-<parameter_description> location to store root window X coordinate of pointer, or %NULL.
+<parameter name="selection">
+<parameter_description> an atom identifying a selection
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> location to store root window Y coordinate of pointer, or %NULL.
+<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="mask">
-<parameter_description> location to store current modifier mask, or %NULL
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gdk_event_send_client_message">
-<description>
-Sends an X ClientMessage event to a given window (which must be
-on the default #GdkDisplay.)
-This could be used for communicating between different applications,
-though the amount of data is limited to 20 bytes.
-
-
-</description>
-<parameters>
-<parameter name="event">
-<parameter_description> the #GdkEvent to send, which should be a #GdkEventClient.
-</parameter_description>
-</parameter>
-<parameter name="winid">
-<parameter_description> the window to send the X ClientMessage event to.
+<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> non-zero on success.
+<return> %TRUE if the selection owner was successfully changed to owner,
+otherwise %FALSE.
+
</return>
</function>
-<function name="gdk_colors_alloc">
+<function name="gdk_selection_property_get">
<description>
-Allocates colors from a colormap. This function
-is obsolete. See gdk_colormap_alloc_colors().
-For full documentation of the fields, see
-the Xlib documentation for <function>XAllocColorCells()</function>.
+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="colormap">
-<parameter_description> a #GdkColormap.
-</parameter_description>
-</parameter>
-<parameter name="contiguous">
-<parameter_description> if %TRUE, the colors should be allocated
-in contiguous color cells.
-</parameter_description>
-</parameter>
-<parameter name="planes">
-<parameter_description> an array in which to store the plane masks.
+<parameter name="requestor">
+<parameter_description> the window on which the data is stored
</parameter_description>
</parameter>
-<parameter name="nplanes">
-<parameter_description> the number of planes to allocate. (Or zero,
-to indicate that the color allocation should not be planar.)
+<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="pixels">
-<parameter_description> an array into which to store allocated pixel values.
+<parameter name="prop_type">
+<parameter_description> location to store the type of the property
</parameter_description>
</parameter>
-<parameter name="npixels">
-<parameter_description> the number of pixels in each plane to allocate.
+<parameter name="prop_format">
+<parameter_description> location to store the format of the property
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the allocation was successful
+<return> the length of the retrieved data.
</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_drag_motion">
+<function name="gdk_selection_send_notify">
<description>
-Updates the drag context when the pointer moves or the
-set of actions changes.
-
-This function is called by the drag source.
-
+Sends a response to SelectionRequest event.
</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 name="requestor">
+<parameter_description> window to which to deliver response.
</parameter_description>
</parameter>
-<parameter name="y_root">
-<parameter_description> the y position of the pointer in root coordinates.
+<parameter name="selection">
+<parameter_description> selection that was requested.
</parameter_description>
</parameter>
-<parameter name="suggested_action">
-<parameter_description> the suggested action.
+<parameter name="target">
+<parameter_description> target that was selected.
</parameter_description>
</parameter>
-<parameter name="possible_actions">
-<parameter_description> the possible actions.
+<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> the timestamp for this operation.
+<parameter_description> timestamp.
</parameter_description>
</parameter>
</parameters>
-<return> FIXME
-</return>
+<return></return>
</function>
-<function name="gdk_test_simulate_button">
+<function name="gdk_selection_send_notify_for_display">
<description>
-This function is intended to be used in Gtk+ test programs.
-It will warp the mouse pointer to the given (@x,@y) corrdinates
-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, gtk_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.
+Send a response to SelectionRequest event.
+Since: 2.2
</description>
<parameters>
-<parameter name="window">
-<parameter_description> Gdk window to simulate a button event for.
+<parameter name="display">
+<parameter_description> the #GdkDisplay where @requestor is realized
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> x coordinate within @window for the button event.
+<parameter name="requestor">
+<parameter_description> window to which to deliver response
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> y coordinate within @window for the button event.
+<parameter name="selection">
+<parameter_description> selection that was requested
</parameter_description>
</parameter>
-<parameter name="button">
-<parameter_description> Number of the pointer button for the event, usually 1, 2 or 3.
+<parameter name="target">
+<parameter_description> target that was selected
</parameter_description>
</parameter>
-<parameter name="modifiers">
-<parameter_description> Keyboard modifiers the event is setup with.
+<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="button_pressrelease">
-<parameter_description> either %GDK_BUTTON_PRESS or %GDK_BUTTON_RELEASE
+<parameter name="time_">
+<parameter_description> timestamp
</parameter_description>
</parameter>
</parameters>
-<return> wether all actions neccessary for a button event simulation were carried out successfully.
-</return>
+<return></return>
</function>
-<function name="gdk_window_withdraw">
+<function name="gdk_set_double_click_time">
<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.
+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 <emphasis>not</emphasis> set this, it is a
+global user-configured setting.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="msec">
+<parameter_description> double click time in milliseconds (thousandths of a second)
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_deiconify">
+<function name="gdk_set_program_class">
<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.
-
+Sets the program class. The X11 backend uses the program class to set
+the class name part of the <literal>WM_CLASS</literal> property on
+toplevel windows; see the ICCCM.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="program_class">
+<parameter_description> a string.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_display_get_maximal_cursor_size">
+<function name="gdk_set_show_events">
<description>
-Gets the maximal size to use for cursors on @display.
-
-Since: 2.4
+Sets whether a trace of received events is output.
+Note that GTK+ must be compiled with debugging (that is,
+configured using the <option>--enable-debug</option> option)
+to use this option.
</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 name="show_events">
+<parameter_description> %TRUE to output event debugging information.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_display_add_client_message_filter">
+<function name="gdk_setting_get">
<description>
-Adds a filter to be called when X ClientMessage events are received.
-See gdk_window_add_filter() if you are interested in filtering other
-types of events.
+Obtains a desktop-wide setting, such as the double-click time,
+for the default screen. See gdk_screen_get_setting().
-Since: 2.2
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay for which this message filter applies
-</parameter_description>
-</parameter>
-<parameter name="message_type">
-<parameter_description> the type of ClientMessage events to receive.
-This will be checked against the @message_type field
-of the XClientMessage event struct.
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> the function to call to process the event.
+<parameter name="name">
+<parameter_description> the name of the setting.
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> user data to pass to @func.
+<parameter name="value">
+<parameter_description> location to store the value of the setting.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the setting existed and a value was stored
+in @value, %FALSE otherwise.
+</return>
</function>
-<function name="gdkx_colormap_get">
+<function name="gdk_test_render_sync">
<description>
-Returns a #GdkColormap corresponding to a X colormap;
-this function only works if the colormap is already
-known to GTK+ (a colormap created by GTK+ or the default
-colormap for the screen), since GTK+
+Retrieves a pixel from @window to force the windowing
+system to carry out any pending rendering commands.
-Always use gdk_x11_colormap_foreign_new() instead.
+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="xcolormap">
-<parameter_description> the XID of a colormap for the default screen.
+<parameter name="window">
+<parameter_description> a mapped #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the existing #GdkColormap object if it was
-already known to GTK+, otherwise warns and return
-%NULL.
-</return>
+<return></return>
</function>
-<function name="gdk_drag_find_window">
+<function name="gdk_test_simulate_button">
<description>
-Finds the destination window and DND protocol to use at the
-given pointer position.
+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.
-This function is called by the drag source to obtain the
- dest_window and @protocol parameters for gdk_drag_motion().
+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="context">
-<parameter_description> a #GdkDragContext.
+<parameter name="window">
+<parameter_description> a #GdkWindow to simulate a button event for
</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 name="x">
+<parameter_description> x coordinate within @window for the button event
</parameter_description>
</parameter>
-<parameter name="x_root">
-<parameter_description> the x position of the pointer in root coordinates.
+<parameter name="y">
+<parameter_description> y coordinate within @window for the button event
</parameter_description>
</parameter>
-<parameter name="y_root">
-<parameter_description> the y position of the pointer in root coordinates.
+<parameter name="button">
+<parameter_description> Number of the pointer button for the event, usually 1, 2 or 3
</parameter_description>
</parameter>
-<parameter name="dest_window">
-<parameter_description> location to store the destination window in.
+<parameter name="modifiers">
+<parameter_description> Keyboard modifiers the event is setup with
</parameter_description>
</parameter>
-<parameter name="protocol">
-<parameter_description> location to store the DND protocol in.
+<parameter name="button_pressrelease">
+<parameter_description> either %GDK_BUTTON_PRESS or %GDK_BUTTON_RELEASE
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether all actions necessary for a button event simulation
+were carried out successfully
+
+</return>
</function>
-<function name="gdk_window_ensure_native">
+<function name="gdk_test_simulate_key">
<description>
-Tries to ensure that there is a window-system native window for this
-GdkWindow. This may fail in some situations, returning %FALSE.
+This function is intended to be used in GTK+ test programs.
+If (@x,@y) are > (-1,-1), it will warp the mouse pointer to
+the given (@x,@y) coordinates within @window and simulate a
+key press or release event.
-Offscreen window and children of them can never have native windows.
+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.
-Some backends may not support native child windows.
+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.18
+Since: 2.14
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GdkWindow
+<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> %TRUE if the window has a native window, %FALSE otherwise
+<return> whether all actions necessary for a key event simulation
+were carried out successfully
</return>
</function>
-<function name="gdk_window_set_title">
+<function name="gdk_text_property_to_utf8_list_for_display">
<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.
+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->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->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->idle_id)
+g_source_remove (self->idle_id);
+G_OBJECT_CLASS (parent_class)->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->timeout_id = 0;
+
+return FALSE;
+}
+
+static void some_widget_do_stuff_later (SomeWidget *self)
+{
+self->timeout_id = g_timeout_add (timeout_callback, self)
+}
+
+static void some_widget_finalize (GObject *object)
+{
+SomeWidget *self = SOME_WIDGET (object);
+
+if (self->timeout_id)
+g_source_remove (self->timeout_id);
+
+G_OBJECT_CLASS (parent_class)->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 macro 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.
+
+</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().
+g_thread_init() must be called previous to this function.
+
+This call must be made before any use of the main loop from
+GTK+; to be safe, call it before gtk_init().
+
+</description>
+<parameters>
+</parameters>
+<return></return>
+</function>
+
+<function name="gdk_threads_leave">
+<description>
+Leaves a critical region begun with gdk_threads_enter().
+
+</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.
+
+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. "Best"
+means "largest," 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 "mask" is the significant bits within the pixel.
+The "shift" is the number of bits left we must shift a primary for it
+to be in position (according to the "mask"). Finally, "precision" 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 "mask" is the significant bits within the pixel.
+The "shift" is the number of bits left we must shift a primary for it
+to be in position (according to the "mask"). Finally, "precision" 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 "mask" is the significant bits within the pixel.
+The "shift" is the number of bits left we must shift a primary for it
+to be in position (according to the "mask"). Finally, "precision" 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 <ulink
+url="http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt">Startup
+Notification Protocol specification</ulink> 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 ("new", "change",
+or "remove")
+</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_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>
@@ -9901,51 +10152,108 @@ user-readable strings in GDK/GTK+). @title may not be %NULL.
<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="title">
-<parameter_description> title of @window
+</parameters>
+<return></return>
+</function>
+
+<function name="gdk_window_begin_move_drag">
+<description>
+Begins a window move operation (for a toplevel window). You might
+use this function to implement a "window move grip," for
+example. The function works best with window managers that support
+the <ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended
+Window Manager Hints</ulink>, but has a fallback implementation for
+other window managers.
+
+
+</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_colormap_get_screen">
+<function name="gdk_window_begin_paint_rect">
<description>
-Gets the screen for which this colormap was created.
+A convenience wrapper around gdk_window_begin_paint_region() which
+creates a rectangular region for you. See
+gdk_window_begin_paint_region() for details.
-Since: 2.2
</description>
<parameters>
-<parameter name="cmap">
-<parameter_description> a #GdkColormap
+<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> the screen for which this colormap was created.
-
-</return>
+<return></return>
</function>
-<function name="gdk_window_flush">
+<function name="gdk_window_begin_paint_region">
<description>
-Flush all outstanding cached operations on a window, leaving the
-window in a state which reflects all that has been drawn before.
+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.
-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 pixmap 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.
+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.
-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.
+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().
-Since: 2.18
</description>
<parameters>
@@ -9953,112 +10261,258 @@ Since: 2.18
<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_display_get_event">
+<function name="gdk_window_begin_resize_drag">
<description>
-Gets the next #GdkEvent to be processed for @display, fetching events from the
-windowing system if necessary.
+Begins a window resize operation (for a toplevel window).
+You might use this function to implement a "window resize grip," for
+example; in fact #GtkStatusbar uses it. The function works best
+with window managers that support the <ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended Window Manager Hints</ulink>, but has a
+fallback implementation for other window managers.
-Since: 2.2
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<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> the next #GdkEvent to be processed, or %NULL if no events
-are pending. The returned #GdkEvent should be freed with gdk_event_free().
-
-</return>
+<return></return>
</function>
-<function name="gdk_window_get_frame_extents">
+<function name="gdk_window_configure_finished">
<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().
+Signal to the window system that the application has finished
+handling Configure events it has received. Window Managers can
+use this to better synchronize the frame repaint with the
+application. GTK+ applications will automatically call this
+function when appropriate.
+
+This function can only be called if gdk_window_enable_synchronized_configure()
+was called previously.
+Since: 2.6
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="rect">
-<parameter_description> rectangle to fill with bounding box of the window frame
+</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_gc_set_fill">
+<function name="gdk_window_coords_from_parent">
<description>
-Set the fill mode for a graphics context.
+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="gc">
-<parameter_description> a #GdkGC.
+<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="fill">
-<parameter_description> the new fill mode.
+<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_display_get_name">
+<function name="gdk_window_coords_to_parent">
<description>
-Gets the name of the display.
+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.
-Since: 2.2
+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="display">
-<parameter_description> a #GdkDisplay
+<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> a string representing the display name. This string is owned
-by GDK and should not be modified or freed.
-
-</return>
+<return></return>
</function>
-<function name="gdk_rgb_get_visual">
+<function name="gdk_window_create_similar_surface">
<description>
-Gets a "preferred visual" chosen by GdkRGB for rendering image data
-on the default screen. In previous versions of GDK, this was the
-only visual GdkRGB could use for rendering. In current versions,
-it's simply the visual GdkRGB would have chosen as the optimal one
-in those previous versions. GdkRGB can now render to drawables with
-any visual.
+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> The #GdkVisual chosen by GdkRGB.
+<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 "nil" surface if @other is already in an error state
+or any other error occurs.
+
</return>
</function>
-<function name="gdk_window_set_startup_id">
+<function name="gdk_window_deiconify">
<description>
-When using GTK+, typically you should use gtk_window_set_startup_id()
-instead of this low-level function.
-
-Since: 2.12
+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>
@@ -10067,20 +10521,19 @@ Since: 2.12
<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_child_shapes">
+<function name="gdk_window_destroy">
<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.
+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>
@@ -10092,103 +10545,94 @@ the shape mask of @window in the masks to be merged.
<return></return>
</function>
-<function name="gdk_x11_get_xatom_by_name_for_display">
+<function name="gdk_window_enable_synchronized_configure">
<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.
+Indicates that the application will cooperate with the window
+system in synchronizing the window repaint with the window
+manager during resizing operations. After an application calls
+this function, it must call gdk_window_configure_finished() every
+time it has finished all processing associated with a set of
+Configure events. Toplevel GTK+ windows automatically use this
+protocol.
-Since: 2.2
+On X, calling this function makes @window participate in the
+_NET_WM_SYNC_REQUEST window manager protocol.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
-</parameter_description>
-</parameter>
-<parameter name="atom_name">
-<parameter_description> a string
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> a X atom for a #GdkDisplay
-
-</return>
+<return></return>
</function>
-<function name="gdk_window_set_keep_below">
+<function name="gdk_window_end_paint">
<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
-"keep below"; 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.
+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.
-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> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_screen_get_monitor_plug_name">
+<function name="gdk_window_ensure_native">
<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.
+Tries to ensure that there is a window-system native window for this
+GdkWindow. This may fail in some situations, returning %FALSE.
-Since: 2.14
+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="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 name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated string containing the name of the monitor,
-or %NULL if the name cannot be determined
+<return> %TRUE if the window has a native window, %FALSE otherwise
</return>
</function>
-<function name="gdk_window_input_shape_combine_mask">
+<function name="gdk_window_flush">
<description>
-Like gdk_window_shape_combine_mask(), 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
-"clickable".
+Flush all outstanding cached operations on a window, leaving the
+window in a state which reflects all that has been drawn before.
-On the X11 platform, this requires version 1.1 of the
-shape extension.
+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.
-On the Win32 platform, this functionality is not present and the
-function does nothing.
+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.10
+Since: 2.18
</description>
<parameters>
@@ -10196,245 +10640,217 @@ Since: 2.10
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="mask">
-<parameter_description> shape mask, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> X position of shape mask with respect to @window
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> Y position of shape mask with respect to @window
-</parameter_description>
-</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_x11_display_set_cursor_theme">
+<function name="gdk_window_focus">
<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_pixmap()
-or 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).
+Sets keyboard focus to @window. In most cases, gtk_window_present()
+should be used on a #GtkWindow, rather than calling this function.
-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 name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> the cursor size to use, or 0 to keep the previous size
+<parameter name="timestamp">
+<parameter_description> timestamp of the event triggering the window focus
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_x11_colormap_get_xcolormap">
+<function name="gdk_window_freeze_toplevel_updates_libgtk_only">
<description>
-Returns the X colormap belonging to a #GdkColormap.
+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="colormap">
-<parameter_description> a #GdkColormap.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> an Xlib <type>Colormap</type>.
-</return>
+<return></return>
</function>
-<function name="gdk_drawable_get_depth">
+<function name="gdk_window_freeze_updates">
<description>
-Obtains the bit depth of the drawable, that is, the number of bits
-that make up a pixel in the drawable's visual. Examples are 8 bits
-per pixel, 24 bits per pixel, etc.
-
+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="drawable">
-<parameter_description> a #GdkDrawable
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> number of bits per pixel
-</return>
+<return></return>
</function>
-<function name="gdk_offscreen_window_set_embedder">
+<function name="gdk_window_fullscreen">
<description>
-Sets @window to be embedded in @embedder.
+Moves the window into fullscreen mode. This means the
+window covers the entire screen and is above any panels
+or task bars.
-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.
+If the window was already fullscreen, then this function does nothing.
-Since: 2.18
+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 "fullscreen"; 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 #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="embedder">
-<parameter_description> the #GdkWindow that @window gets embedded in
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_display_supports_clipboard_persistence">
+<function name="gdk_window_geometry_changed">
<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.
+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.6
+Since: 2.18
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="window">
+<parameter_description> an embedded offscreen #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the display supports clipboard persistance.
-
-</return>
+<return></return>
</function>
-<function name="gdk_window_is_visible">
+<function name="gdk_window_get_accept_focus">
<description>
-Checks whether the window has been mapped (with gdk_window_show() or
-gdk_window_show_unraised()).
+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 #GdkWindow
+<parameter_description> a toplevel #GdkWindow.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the window is mapped
+<return> whether or not the window should receive input focus.
+
</return>
</function>
-<function name="gdk_color_white">
+<function name="gdk_window_get_background_pattern">
<description>
-Returns the white color for a given colormap. The resulting
-value has already allocated been allocated.
+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="colormap">
-<parameter_description> a #GdkColormap.
-</parameter_description>
-</parameter>
-<parameter name="color">
-<parameter_description> the location to store the color.
+<parameter name="window">
+<parameter_description> a window
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the allocation succeeded.
+<return> The pattern to use for the background or
+%NULL to use the parent's background.
+
</return>
</function>
-<function name="gdk_wcstombs">
+<function name="gdk_window_get_children">
<description>
-Converts a wide character string to a multi-byte string.
-(The function name comes from an acronym of 'Wide Character String TO
-Multi-Byte String').
+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="src">
-<parameter_description> a wide character string.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the multi-byte string corresponding to @src, or %NULL if the
-conversion failed. The returned string should be freed with g_free() when no
-longer needed.
+<return>
+list of child windows inside @window
</return>
</function>
-<function name="gdk_input_add_full">
+<function name="gdk_window_get_clip_region">
<description>
-Establish a callback when a condition becomes true on
-a file descriptor.
+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.
-Deprecated: 2.14: Use g_io_add_watch_full() on a #GIOChannel
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a file descriptor.
-</parameter_description>
-</parameter>
-<parameter name="condition">
-<parameter_description> the condition.
-</parameter_description>
-</parameter>
-<parameter name="function">
-<parameter_description> the callback function.
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> callback data passed to @function.
-</parameter_description>
-</parameter>
-<parameter name="destroy">
-<parameter_description> callback function to call with @data when the input
-handler is removed.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> a tag that can later be used as an argument to
-gdk_input_remove().
-
+<return> a #cairo_region_t. This must be freed with cairo_region_destroy()
+when you are done.
</return>
</function>
-<function name="gdk_display_get_default">
+<function name="gdk_window_get_composited">
<description>
-Gets the default #GdkDisplay. This is a convenience
-function for
-<literal>gdk_display_manager_get_default_display (gdk_display_manager_get ())</literal>.
+Determines whether @window is composited.
-Since: 2.2
+See gdk_window_set_composited().
+
+Since: 2.22
</description>
<parameters>
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
</parameters>
-<return> a #GdkDisplay, or %NULL if there is no default
-display.
+<return> %TRUE if the window is composited.
</return>
</function>
@@ -10455,201 +10871,173 @@ Since: 2.18
</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> 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_text_height">
+<function name="gdk_window_get_decorations">
<description>
-Determines the total height of a given string.
-This value is not generally useful, because you cannot
-determine how this total height will be drawn in
-relation to the baseline. See gdk_text_extents().
+Returns the decorations set on the GdkWindow with
+gdk_window_set_decorations().
</description>
<parameters>
-<parameter name="font">
-<parameter_description> a #GdkFont
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> the text to measure.
+<parameter name="window">
+<parameter_description> The toplevel #GdkWindow to get the decorations from
</parameter_description>
</parameter>
-<parameter name="text_length">
-<parameter_description> the length of the text in bytes.
+<parameter name="decorations">
+<parameter_description> The window decorations will be written here
</parameter_description>
</parameter>
</parameters>
-<return> the height of the string in pixels.
+<return> %TRUE if the window has decorations set, %FALSE otherwise.
</return>
</function>
-<function name="gdk_window_set_child_input_shapes">
+<function name="gdk_window_get_device_cursor">
<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.
+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: 2.10
+Since: 3.0
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter_description> a #GdkWindow.
</parameter_description>
</parameter>
-</parameters>
-<return></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 or %NULL to use the default keymap
+<parameter name="device">
+<parameter_description> a master, pointer #GdkDevice.
</parameter_description>
</parameter>
</parameters>
-<return> %PANGO_DIRECTION_LTR or %PANGO_DIRECTION_RTL
-if it can determine the direction. %PANGO_DIRECTION_NEUTRAL
-otherwise.
+<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_display_set_double_click_time">
+<function name="gdk_window_get_device_events">
<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 <emphasis>not</emphasis> set this, it is a global
-user-configured setting.
+Returns the event mask for @window corresponding to an specific device.
-Since: 2.2
+Since: 3.0
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="window">
+<parameter_description> a #GdkWindow.
</parameter_description>
</parameter>
-<parameter name="msec">
-<parameter_description> double click time in milliseconds (thousandths of a second)
+<parameter name="device">
+<parameter_description> a #GdkDevice.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> device event mask for @window
+
+</return>
</function>
-<function name="gdk_event_send_client_message_for_display">
+<function name="gdk_window_get_device_position">
<description>
-On X11, sends an X ClientMessage event to a given window. On
-Windows, sends a message registered with the name
-GDK_WIN32_CLIENT_MESSAGE.
-
-This could be used for communicating between different
-applications, though the amount of data is limited to 20 bytes on
-X11, and to just four bytes on Windows.
+Obtains the current device position and modifier state.
+The position is given in coordinates relative to the upper left
+corner of @window.
-Since: 2.2
+Since: 3.0
</description>
<parameters>
-<parameter name="display">
-<parameter_description> the #GdkDisplay for the window where the message is to be sent.
+<parameter name="window">
+<parameter_description> a #GdkWindow.
</parameter_description>
</parameter>
-<parameter name="event">
-<parameter_description> the #GdkEvent to send, which should be a #GdkEventClient.
+<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="winid">
-<parameter_description> the window to send the client message to.
+<parameter name="y">
+<parameter_description> return location for the Y coordinate of @device, or %NULL.
</parameter_description>
</parameter>
-</parameters>
-<return> non-zero on success.
-
-</return>
-</function>
-
-<function name="gdk_region_destroy">
-<description>
-Destroys a #GdkRegion.
-
-</description>
-<parameters>
-<parameter name="region">
-<parameter_description> a #GdkRegion
+<parameter name="mask">
+<parameter_description> return location for the modifier mask, or %NULL.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<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_event_copy">
+<function name="gdk_window_get_display">
<description>
-Copies a #GdkEvent, copying or incrementing the reference count of the
-resources associated with it (e.g. #GdkWindow's and strings).
+Gets the #GdkDisplay associated with a #GdkWindow.
+Since: 2.24
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #GdkEvent
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> a copy of @event. The returned #GdkEvent should be freed with
-gdk_event_free().
+<return> the #GdkDisplay associated with @window
+
</return>
</function>
-<function name="gdk_text_measure">
+<function name="gdk_window_get_drag_protocol">
<description>
-Determines the distance from the origin to the rightmost
-portion of a string when drawn. This is not the
-correct value for determining the origin of the next
-portion when drawing text in multiple pieces.
-See gdk_text_width().
+Finds out the DND protocol supported by a window.
+Since: 3.0
</description>
<parameters>
-<parameter name="font">
-<parameter_description> a #GdkFont
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> the text to measure.
+<parameter name="window">
+<parameter_description> the destination window
</parameter_description>
</parameter>
-<parameter name="text_length">
-<parameter_description> the length of the text in bytes.
+<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 right bearing of the string in pixels.
+<return> the supported DND protocol.
+
</return>
</function>
-<function name="gdk_window_show_unraised">
+<function name="gdk_window_get_effective_parent">
<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.
+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.
-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).
+See also: gdk_offscreen_window_get_embedder()
+
+Since: 2.22
</description>
<parameters>
@@ -10658,139 +11046,149 @@ that you can't really use XMapWindow() directly on a GDK window).
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> effective parent of @window
+
+</return>
</function>
-<function name="gdk_drawable_get_clip_region">
+<function name="gdk_window_get_effective_toplevel">
<description>
-Computes the region of a drawable that potentially can be written
-to by drawing primitives. This region will not take into account
-the clip region for the GC, and may also 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.
+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="drawable">
-<parameter_description> a #GdkDrawable
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkRegion. This must be freed with gdk_region_destroy()
-when you are done.
+<return> the effective toplevel window containing @window
+
</return>
</function>
-<function name="gdk_screen_get_monitor_at_window">
+<function name="gdk_window_get_events">
<description>
-Returns the number of the monitor in which the largest area of the
-bounding rectangle of @window resides.
+Gets the event mask for @window for all master input devices. See
+gdk_window_set_events().
-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> event mask for @window
</return>
</function>
-<function name="gdk_keymap_get_caps_lock_state">
+<function name="gdk_window_get_focus_on_map">
<description>
-Returns whether the Caps Lock modifer is locked.
+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.16
+Since: 2.22
</description>
<parameters>
-<parameter name="keymap">
-<parameter_description> a #GdkKeymap
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if Caps Lock is on
+<return> whether or not the window wants to receive input focus when
+it is mapped.
</return>
</function>
-<function name="gdk_drag_begin">
+<function name="gdk_window_get_frame_extents">
<description>
-Starts a drag and creates a new drag context for it.
-
-This function is called by the drag source.
+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> the source window for this drag.
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="targets">
-<parameter_description> the offered targets, as list of #GdkAtom<!-- -->s
+<parameter name="rect">
+<parameter_description> rectangle to fill with bounding box of the window frame
</parameter_description>
</parameter>
</parameters>
-<return> a newly created #GdkDragContext.
-</return>
+<return></return>
</function>
-<function name="gdk_display_manager_get">
+<function name="gdk_window_get_geometry">
<description>
-Gets the singleton #GdkDisplayManager object.
-
-Since: 2.2
+Any of the return location arguments to this function may be %NULL,
+if you aren't interested in getting the value of that field.
-</description>
-<parameters>
-</parameters>
-<return> The global #GdkDisplayManager singleton; gdk_parse_pargs(),
-gdk_init(), or gdk_init_check() must have been called first.
+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).
-</return>
-</function>
+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.
-<function name="gdk_gc_set_function">
-<description>
-Determines how the current pixel values and the
-pixel values being drawn are combined to produce
-the final pixel values.
+<note>
+If @window is not a toplevel, it is <emphasis>much</emphasis> 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.
+</note>
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="function">
-<parameter_description> the #GdkFunction to use
+<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_deskrelative_origin">
+<function name="gdk_window_get_group">
<description>
-This gets the origin of a #GdkWindow relative to
-an Enlightenment-window-manager desktop. As long as you don't
-assume that the user's desktop/workspace covers the entire
-root window (i.e. you don't assume that the desktop begins
-at root window coordinate 0,0) this function is not necessary.
-It's deprecated for that reason.
+Returns the group leader window for @window. See gdk_window_set_group().
+Since: 2.4
</description>
<parameters>
@@ -10798,181 +11196,180 @@ It's deprecated for that reason.
<parameter_description> a toplevel #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
+<return> the group leader window for @window
+
</return>
</function>
-<function name="gdk_drop_reply">
+<function name="gdk_window_get_height">
<description>
-Accepts or rejects a drop.
+Returns the height of the given @window.
-This function is called by the drag destination in response
-to a drop initiated by the drag source.
+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="context">
-<parameter_description> a #GdkDragContext.
-</parameter_description>
-</parameter>
-<parameter name="ok">
-<parameter_description> %TRUE if the drop is accepted.
-</parameter_description>
-</parameter>
-<parameter name="time_">
-<parameter_description> the timestamp for this operation.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The height of @window
+
+</return>
</function>
-<function name="gdk_screen_get_width_mm">
+<function name="gdk_window_get_modal_hint">
<description>
-Gets the width of @screen in millimeters.
-Note that on some X servers this value will not be correct.
+Determines whether or not the window manager is hinted that @window
+has modal behaviour.
-Since: 2.2
+Since: 2.22
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="window">
+<parameter_description> A toplevel #GdkWindow.
</parameter_description>
</parameter>
</parameters>
-<return> the width of @screen in millimeters.
+<return> whether or not the window has the modal hint set.
</return>
</function>
-<function name="gdk_screen_set_resolution">
+<function name="gdk_window_get_origin">
<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).
+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.)
-Since: 2.10
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="dpi">
-<parameter_description> the resolution in "dots per inch". (Physical inches aren't actually
-involved; the terminology is conventional.)
+<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></return>
+<return> not meaningful, ignore
+</return>
</function>
-<function name="gdk_window_set_functions">
+<function name="gdk_window_get_parent">
<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.
+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.
-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.
+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 toplevel #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="functions">
-<parameter_description> bitmask of operations to allow on @window
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> parent of @window
+</return>
</function>
-<function name="gdk_keyval_to_unicode">
+<function name="gdk_window_get_pointer">
<description>
-Convert from a GDK key symbol to the corresponding ISO10646 (Unicode)
-character.
+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="keyval">
-<parameter_description> a GDK key symbol
+<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 corresponding unicode character, or 0 if there
-is no corresponding character.
+<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_event_handler_set">
+<function name="gdk_window_get_position">
<description>
-Sets the function to call to handle all events from GDK.
+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.
-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 name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> user data to pass to the function.
+<parameter name="x">
+<parameter_description> X coordinate of window
</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 name="y">
+<parameter_description> Y coordinate of window
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_shape_combine_region">
+<function name="gdk_window_get_root_coords">
<description>
-Makes pixels in @window outside @shape_region be transparent,
-so that the window may be nonrectangular. See also
-gdk_window_shape_combine_mask() to use a bitmap as the mask.
-
-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.
+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.
-This function works on both toplevel and child windows.
+Since: 2.18
</description>
<parameters>
@@ -10980,535 +11377,430 @@ This function works on both toplevel and child windows.
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="shape_region">
-<parameter_description> region of window to be non-transparent
+<parameter name="x">
+<parameter_description> X coordinate in window
</parameter_description>
</parameter>
-<parameter name="offset_x">
-<parameter_description> X position of @shape_region in @window coordinates
+<parameter name="y">
+<parameter_description> Y coordinate in window
</parameter_description>
</parameter>
-<parameter name="offset_y">
-<parameter_description> Y position of @shape_region in @window coordinates
+<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_lookup_for_display">
+<function name="gdk_window_get_root_origin">
<description>
-Looks up the #GdkWindow that wraps the given native window handle.
-
-For example in the X backend, a native window handle is an Xlib
-<type>XID</type>.
+Obtains the top-left corner of the window manager frame in root
+window coordinates.
-Since: 2.2
</description>
<parameters>
-<parameter name="display">
-<parameter_description> the #GdkDisplay corresponding to the window handle
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="anid">
-<parameter_description> a native window handle.
+<parameter name="x">
+<parameter_description> return location for X position of window frame
</parameter_description>
</parameter>
-</parameters>
-<return> the #GdkWindow wrapper for the native window,
-or %NULL if there is none.
-
-</return>
-</function>
-
-<function name="gdk_pango_renderer_new">
-<description>
-Creates a new #PangoRenderer for @screen. Normally you can use the
-results of gdk_pango_renderer_get_default() rather than creating a new
-renderer.
-
-Since: 2.6
-
-</description>
-<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="y">
+<parameter_description> return location for Y position of window frame
</parameter_description>
</parameter>
</parameters>
-<return> a newly created #PangoRenderer. Free with g_object_unref().
-
-</return>
+<return></return>
</function>
-<function name="gdk_x11_display_get_startup_notification_id">
+<function name="gdk_window_get_screen">
<description>
-Gets the startup notification ID for a display.
+Gets the #GdkScreen associated with a #GdkWindow.
-Since: 2.12
+Since: 2.24
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the startup notification ID for @display
+<return> the #GdkScreen associated with @window
</return>
</function>
-<function name="gdk_x11_screen_supports_net_wm_hint">
+<function name="gdk_window_get_source_events">
<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
-<ulink url="http://www.freedesktop.org">http://www.freedesktop.org</ulink>.
-
-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.
+Returns the event mask for @window corresponding to the device class specified
+by @source.
-Since: 2.2
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> the relevant #GdkScreen.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="property">
-<parameter_description> a property atom.
+<parameter name="source">
+<parameter_description> a #GdkInputSource to define the source class.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the window manager supports @property
-
+<return> source event mask for @window
</return>
</function>
-<function name="gdk_device_get_core_pointer">
+<function name="gdk_window_get_state">
<description>
-Returns the core pointer device for the default display.
+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> the core pointer device; this is owned by the
-display and should not be freed.
+<return> window state bitfield
</return>
</function>
-<function name="gdk_atom_intern_static_string">
+<function name="gdk_window_get_support_multidevice">
<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 <emphasis>always</emphasis> 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).
+Returns %TRUE if the window is aware of the existence of multiple
+devices.
-Since: 2.10
+Since: 3.0
</description>
<parameters>
-<parameter name="atom_name">
-<parameter_description> a static string
+<parameter name="window">
+<parameter_description> a #GdkWindow.
</parameter_description>
</parameter>
</parameters>
-<return> the atom corresponding to @atom_name
+<return> %TRUE if the window handles multidevice features.
</return>
</function>
-<function name="gdk_selection_owner_get_for_display">
+<function name="gdk_window_get_toplevel">
<description>
-Determine the owner of the given selection.
+Gets the toplevel window that's an ancestor of @window.
-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.
+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.
-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 name="window">
+<parameter_description> a #GdkWindow
</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> the toplevel window containing @window
</return>
</function>
-<function name="gdk_device_get_history">
+<function name="gdk_window_get_type_hint">
<description>
-Obtains the motion history for a 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.)
+This function returns the type hint set for a window.
+Since: 2.10
</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> A toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the windowing system supports motion history and
-at least one event was found.
+<return> The type hint set for @window
+
</return>
</function>
-<function name="gdk_gc_set_ts_origin">
+<function name="gdk_window_get_update_area">
<description>
-Set the origin when using tiles or stipples with
-the GC. The tile or stipple will be aligned such
-that the upper left corner of the tile or stipple
-will coincide with this point.
+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="gc">
-<parameter_description> a #GdkGC.
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x-coordinate of the origin.
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> the y-coordinate of the origin.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the update area for @window
+</return>
</function>
-<function name="gdk_window_iconify">
+<function name="gdk_window_get_user_data">
<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.
+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 toplevel #GdkWindow
+<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_set_decorations">
+<function name="gdk_window_get_visible_region">
<description>
-"Decorations" 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.
+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 toplevel #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="decorations">
-<parameter_description> decoration hint mask
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #cairo_region_t. This must be freed with cairo_region_destroy()
+when you are done.
+</return>
</function>
-<function name="gdk_draw_string">
+<function name="gdk_window_get_visual">
<description>
-Draws a string of characters in the given font or fontset.
+Gets the #GdkVisual describing the pixel format of @window.
-Deprecated: 2.4: Use gdk_draw_layout() instead.
+Since: 2.24
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
-</parameter_description>
-</parameter>
-<parameter name="font">
-<parameter_description> a #GdkFont.
-</parameter_description>
-</parameter>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x coordinate of the left edge of the text.
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> the y coordinate of the baseline of the text.
-</parameter_description>
-</parameter>
-<parameter name="string">
-<parameter_description> the string of characters to draw.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GdkVisual
+
+</return>
</function>
-<function name="gdk_threads_add_idle">
+<function name="gdk_window_get_width">
<description>
-A wrapper for the common usage of gdk_threads_add_idle_full()
-assigning the default priority, #G_PRIORITY_DEFAULT_IDLE.
+Returns the width of the given @window.
-See gdk_threads_add_idle_full().
+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.12
+Since: 2.24
</description>
<parameters>
-<parameter name="function">
-<parameter_description> function to call
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @function
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
+<return> The width of @window
</return>
</function>
-<function name="gdk_window_set_override_redirect">
+<function name="gdk_window_get_window_type">
<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.
+Gets the type of the window. See #GdkWindowType.
</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> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> type of window
+</return>
</function>
-<function name="gdk_display_manager_set_default_display">
+<function name="gdk_window_has_native">
<description>
-Sets @display as the default display.
+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.2
+Since: 2.22
</description>
<parameters>
-<parameter name="display_manager">
-<parameter_description> a #GdkDisplayManager
-</parameter_description>
-</parameter>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the %window has a native window, %FALSE otherwise.
+
+</return>
</function>
-<function name="gdk_add_option_entries_libgtk_only">
+<function name="gdk_window_hide">
<description>
-Appends gdk option entries to the passed in option group. This is
-not public API and must not be used by applications.
+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="group">
-<parameter_description> An option group.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_foreign_new">
+<function name="gdk_window_iconify">
<description>
-Wraps a native window for the default display in a #GdkWindow.
-This may fail if the window has been destroyed.
+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.
-For example in the X backend, a native window handle is an Xlib
-<type>XID</type>.
+This function only makes sense when @window is a toplevel window.
</description>
<parameters>
-<parameter name="anid">
-<parameter_description> a native window handle.
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the newly-created #GdkWindow wrapper for the
-native window or %NULL if the window has been destroyed.
-</return>
+<return></return>
</function>
-<function name="gdk_win32_hdc_get">
+<function name="gdk_window_input_shape_combine_region">
<description>
-Allocates a Windows device context handle (HDC) for drawing into
- drawable, and sets it up appropriately according to @usage.
-
-Each #GdkGC can at one time have only one HDC associated with it.
-
-The following flags in @mask are handled:
+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.
-If %GDK_GC_FOREGROUND is set in @mask, a solid brush of the
-foreground color in @gc is selected into the HDC. The text color of
-the HDC is also set. If the @drawable has a palette (256-color
-mode), the palette is selected and realized.
+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
+"clickable".
-If any of the line attribute flags (%GDK_GC_LINE_WIDTH,
-%GDK_GC_LINE_STYLE, %GDK_GC_CAP_STYLE and %GDK_GC_JOIN_STYLE) is
-set in @mask, a solid pen of the foreground color and appropriate
-width and stule is created and selected into the HDC. Note that the
-dash properties are not completely implemented.
+On the X11 platform, this requires version 1.1 of the
+shape extension.
-If the %GDK_GC_FONT flag is set, the background mix mode is set to
-%TRANSPARENT. and the text alignment is set to
-%TA_BASELINE|%TA_LEFT. Note that no font gets selected into the HDC
-by this function.
+On the Win32 platform, this functionality is not present and the
+function does nothing.
-Some things are done regardless of @mask: If the function in @gc is
-any other than %GDK_COPY, the raster operation of the HDC is
-set. If @gc has a clip mask, the clip region of the HDC is set.
+Since: 2.10
-Note that the fill style, tile, stipple, and tile and stipple
-origins in the @gc are ignored by this function. (In general, tiles
-and stipples can't be implemented directly on Win32; you need to do
-multiple pass drawing and blitting to implement tiles or
-stipples. GDK does just that when you call the GDK drawing
-functions with a GC that asks for tiles or stipples.)
+</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>
-When the HDC is no longer used, it should be released by calling
-<function>gdk_win32_hdc_release()</function> with the same
-parameters.
+<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 "dirty region." 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.
-If you modify the HDC by calling <function>SelectObject</function>
-you should undo those modifications before calling
-<function>gdk_win32_hdc_release()</function>.
+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="drawable">
-<parameter_description> destination #GdkDrawable
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="gc">
-<parameter_description> #GdkGC to use for drawing on @drawable
+<parameter name="region">
+<parameter_description> a #cairo_region_t
</parameter_description>
</parameter>
-<parameter name="usage">
-<parameter_description> mask indicating what properties needs to be set up
+<parameter name="child_func">
+<parameter_description> function to use to decide if to
+recurse to a child, %NULL means never recurse.
</parameter_description>
</parameter>
-</parameters>
-<return> The HDC.
-</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 name="user_data">
+<parameter_description> data passed to @child_func
</parameter_description>
</parameter>
</parameters>
-<return> a X atom for GDK's default display.
-</return>
+<return></return>
</function>
-<function name="gdk_window_clear">
+<function name="gdk_window_invalidate_rect">
<description>
-Clears an entire @window to the background color or background pixmap.
+A convenience wrapper around gdk_window_invalidate_region() which
+invalidates a rectangular region. See
+gdk_window_invalidate_region() for details.
</description>
<parameters>
@@ -11516,22 +11808,38 @@ Clears an entire @window to the background color or background pixmap.
<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_freeze_toplevel_updates_libgtk_only">
+<function name="gdk_window_invalidate_region">
<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.
+Adds @region to the update area for @window. The update area is the
+region that needs to be redrawn, or "dirty region." 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.
-This function is not part of the GDK public API and is only
-for use by GTK+.
+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>
@@ -11539,47 +11847,41 @@ for use by GTK+.
<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_cairo_create">
+<function name="gdk_window_is_destroyed">
<description>
-Creates a Cairo context for drawing to @drawable.
-
-<note><para>
-Note that due to double-buffering, Cairo contexts created
-in a GTK+ expose event handler cannot be cached and reused
-between different expose events.
-</para></note>
+Check to see if a window is destroyed..
-Since: 2.8
+Since: 2.18
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<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> %TRUE if the window is destroyed
</return>
</function>
-<function name="gdk_window_set_icon_name">
+<function name="gdk_window_is_input_only">
<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.
+Determines whether or not the window is an input only window.
-Using %NULL for @name unsets the icon title; further calls to
-gdk_window_set_title() will again update the icon title as well.
+Since: 2.22
</description>
<parameters>
@@ -11587,86 +11889,53 @@ gdk_window_set_title() will again update the icon title as well.
<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_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().
-
+<return> %TRUE if @window is input only
-</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_gc_copy">
+<function name="gdk_window_is_shaped">
<description>
-Copy the set of values from one graphics context
-onto another graphics context.
+Determines whether or not the window is shaped.
+
+Since: 2.22
</description>
<parameters>
-<parameter name="dst_gc">
-<parameter_description> the destination graphics context.
-</parameter_description>
-</parameter>
-<parameter name="src_gc">
-<parameter_description> the source graphics context.
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return></return>
-</function>
-
-<function name="gdk_rgb_get_colormap">
-<description>
-Get the preferred colormap for rendering image data. Not a
-very useful function; historically, GDK could only render RGB image
-data to one colormap and visual, but in the current version it can
-render to any colormap and visual. So there's no need to call this
-function.
-
+<return> %TRUE if @window is shaped
-</description>
-<parameters>
-</parameters>
-<return> the preferred colormap
</return>
</function>
-<function name="gdk_colormap_get_visual">
+<function name="gdk_window_is_viewable">
<description>
-Returns the visual for which a given colormap was created.
+Check if the window and all ancestors of the window are
+mapped. (This is not necessarily "viewable" 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="colormap">
-<parameter_description> a #GdkColormap.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the visual of the colormap.
+<return> %TRUE if the window is viewable
</return>
</function>
-<function name="gdk_window_is_viewable">
+<function name="gdk_window_is_visible">
<description>
-Check if the window and all ancestors of the window are
-mapped. (This is not necessarily "viewable" in the X sense, since
-we only check as far as we have GDK window parents, not to the root
-window.)
+Checks whether the window has been mapped (with gdk_window_show() or
+gdk_window_show_unraised()).
</description>
@@ -11676,149 +11945,140 @@ window.)
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the window is viewable
+<return> %TRUE if the window is mapped
</return>
</function>
-<function name="gdk_screen_get_height_mm">
+<function name="gdk_window_lower">
<description>
-Returns the height of @screen in millimeters.
-Note that on some X servers this value will not be correct.
+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.
-Since: 2.2
+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="screen">
-<parameter_description> a #GdkScreen
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the heigth of @screen in millimeters.
-
-</return>
+<return></return>
</function>
-<function name="gdk_x11_gc_get_xdisplay">
+<function name="gdk_window_maximize">
<description>
-Returns the display of a #GdkGC.
+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
+"maximized"; 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="gc">
-<parameter_description> a #GdkGC.
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> an Xlib <type>Display*</type>.
-</return>
+<return></return>
</function>
-<function name="gdk_gc_new">
+<function name="gdk_window_merge_child_input_shapes">
<description>
-Create a new graphics context with default values.
+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="drawable">
-<parameter_description> a #GdkDrawable. The created GC must always be used
-with drawables of the same depth as this one.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the new graphics context.
-</return>
+<return></return>
</function>
-<function name="gdk_display_flush">
+<function name="gdk_window_merge_child_shapes">
<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.
+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().
-Since: 2.4
+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="display">
-<parameter_description> a #GdkDisplay
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_pango_layout_line_get_clip_region">
+<function name="gdk_window_move">
<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 same
-position you would pass to gdk_draw_layout_line(). @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.
+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="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 name="window">
+<parameter_description> a #GdkWindow
</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 name="x">
+<parameter_description> X coordinate relative to window's parent
</parameter_description>
</parameter>
-<parameter name="n_ranges">
-<parameter_description> number of ranges in @index_ranges, i.e. half the size of @index_ranges
+<parameter name="y">
+<parameter_description> Y coordinate relative to window's parent
</parameter_description>
</parameter>
</parameters>
-<return> a clip region containing the given ranges
-</return>
+<return></return>
</function>
-<function name="gdk_window_invalidate_maybe_recurse">
+<function name="gdk_window_move_region">
<description>
-Adds @region to the update area for @window. The update area is the
-region that needs to be redrawn, or "dirty region." 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.
+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.
-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.
+Child windows are not moved.
-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.
+Since: 2.8
</description>
<parameters>
@@ -11827,335 +12087,198 @@ invalidated.
</parameter_description>
</parameter>
<parameter name="region">
-<parameter_description> a #GdkRegion
+<parameter_description> The #cairo_region_t to move
</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 name="dx">
+<parameter_description> Amount to move in the X direction
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> data passed to @child_func
+<parameter name="dy">
+<parameter_description> Amount to move in the Y direction
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_string_width">
+<function name="gdk_window_move_resize">
<description>
-Determines the width of a nul-terminated string.
-(The distance from the origin of the string to the
-point where the next string in a sequence of strings
-should be drawn)
-
+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="font">
-<parameter_description> a #GdkFont
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="string">
-<parameter_description> the nul-terminated string to measure
+<parameter name="x">
+<parameter_description> new X position relative to window's parent
</parameter_description>
</parameter>
-</parameters>
-<return> the width of the string in pixels.
-</return>
-</function>
-
-<function name="gdk_region_union_with_rect">
-<description>
-Sets the area of @region to the union of the areas of @region and
- rect The resulting area is the set of pixels contained in
-either @region or @rect.
-
-</description>
-<parameters>
-<parameter name="region">
-<parameter_description> a #GdkRegion.
+<parameter name="y">
+<parameter_description> new Y position relative to window's parent
</parameter_description>
</parameter>
-<parameter name="rect">
-<parameter_description> a #GdkRectangle.
+<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_screen_is_composited">
+<function name="gdk_window_new">
<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.
+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.
-Since: 2.10
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<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> Whether windows with RGBA visuals can reasonably be
-expected to have their alpha channels drawn correctly on the screen.
-
+<return> the new #GdkWindow
</return>
</function>
-<function name="gdk_keymap_translate_keyboard_state">
+<function name="gdk_window_peek_children">
<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 <xref linkend="key-group-explanation"/> 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.
-
-<note><para>
- 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 <literal>plus</literal>
-symbol is shifted, so when comparing a key press to a
-<literal><Control>plus</literal> accelerator <Shift> should
-be masked out.
-</para>
-<informalexample><programlisting>
- / * We want to ignore irrelevant modifiers like ScrollLock * /
-define ALL_ACCELS_MASK (GDK_CONTROL_MASK | GDK_SHIFT_MASK | GDK_MOD1_MASK)
-gdk_keymap_translate_keyboard_state (keymap, event->hardware_keycode,
-event->state, event->group,
-&keyval, NULL, NULL, &consumed);
-if (keyval == GDK_PLUS &&
-(event->state & ~consumed & ALL_ACCELS_MASK) == GDK_CONTROL_MASK)
- / * Control was pressed * /
-</programlisting></informalexample>
-<para>
-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:</para>
-<informalexample><programlisting>
- / * XXX Don't do this XXX * /
-if (keyval == accel_keyval &&
-(event->state & ~consumed & ALL_ACCELS_MASK) == (accel_mods & ~consumed))
- / * Accelerator was pressed * /
-</programlisting></informalexample>
-<para>
-However, this did not work if multi-modifier combinations were
-used in the keymap, since, for instance, <literal><Control></literal>
-would be masked out even if only <literal><Control><Alt></literal>
-was used in the keymap. To support this usage as well as well as
-possible, all <emphasis>single modifier</emphasis> 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 <literal><Control>plus</literal>,
-not <literal><Control><Shift>plus</literal>,
-</para></note>
+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="keymap">
-<parameter_description> a #GdkKeymap, or %NULL to use the default
-</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 name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if there was a keyval bound to the keycode/state/group
+<return>
+a reference to the list of child windows in @window
</return>
</function>
-<function name="gdk_drag_context_new">
+<function name="gdk_window_process_all_updates">
<description>
-Creates a new #GdkDragContext.
+Calls gdk_window_process_updates() for all windows (see #GdkWindow)
+in the application.
</description>
<parameters>
</parameters>
-<return> the newly created #GdkDragContext.
-</return>
+<return></return>
</function>
-<function name="gdk_draw_text_wc">
+<function name="gdk_window_process_updates">
<description>
-Draws a number of wide characters using the given font of fontset.
-If the font is a 1-byte font, the string is converted into 1-byte
-characters (discarding the high bytes) before output.
+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.
-Deprecated: 2.4: Use gdk_draw_layout() instead.
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
-</parameter_description>
-</parameter>
-<parameter name="font">
-<parameter_description> a #GdkFont.
-</parameter_description>
-</parameter>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x coordinate of the left edge of the text.
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> the y coordinate of the baseline of the text.
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> the wide characters to draw.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="text_length">
-<parameter_description> the number of characters to draw.
+<parameter name="update_children">
+<parameter_description> whether to also process updates for child windows
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_app_launch_context_set_icon_name">
+<function name="gdk_window_raise">
<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.
+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.
-Since: 2.14
+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="context">
-<parameter_description> a #GdkAppLaunchContext
-</parameter_description>
-</parameter>
-<parameter name="icon_name">
-<parameter_description> an icon name, or %NULL
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_draw_drawable">
+<function name="gdk_window_register_dnd">
<description>
-Copies the @width x @height region of @src at coordinates (@xsrc,
- ysrc) to coordinates (@xdest, @ydest) in @drawable.
- width and/or @height may be given as -1, in which case the entire
- src drawable will be copied.
-
-Most fields in @gc are not used for this operation, but notably the
-clip mask or clip region will be honored.
-
-The source and destination drawables must have the same visual and
-colormap, or errors will result. (On X11, failure to match
-visual/colormap results in a BadMatch error from the X server.)
-A common cause of this problem is an attempt to draw a bitmap to
-a color drawable. The way to draw a bitmap is to set the bitmap as
-the stipple on the #GdkGC, set the fill mode to %GDK_STIPPLED, and
-then draw the rectangle.
+Registers a window as a potential drop destination.
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
-</parameter_description>
-</parameter>
-<parameter name="gc">
-<parameter_description> a #GdkGC sharing the drawable's visual and colormap
-</parameter_description>
-</parameter>
-<parameter name="src">
-<parameter_description> the source #GdkDrawable, which may be the same as @drawable
-</parameter_description>
-</parameter>
-<parameter name="xsrc">
-<parameter_description> X position in @src of rectangle to draw
-</parameter_description>
-</parameter>
-<parameter name="ysrc">
-<parameter_description> Y position in @src of rectangle to draw
-</parameter_description>
-</parameter>
-<parameter name="xdest">
-<parameter_description> X position in @drawable where the rectangle should be drawn
+<parameter name="window">
+<parameter_description> a #GdkWindow.
</parameter_description>
</parameter>
-<parameter name="ydest">
-<parameter_description> Y position in @drawable where the rectangle should be drawn
+</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="width">
-<parameter_description> width of rectangle to draw, or -1 for entire @src width
+<parameter name="function">
+<parameter_description> previously-added filter function
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> height of rectangle to draw, or -1 for entire @src height
+<parameter name="data">
+<parameter_description> user data for previously-added filter function
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_end_paint">
+<function name="gdk_window_reparent">
<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.
+Reparents @window into the given @new_parent. The window being
+reparented will be unmapped as a side effect.
</description>
@@ -12164,221 +12287,215 @@ gdk_window_begin_paint_region() first.
<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_event_get_graphics_expose">
+<function name="gdk_window_resize">
<description>
-Waits for a GraphicsExpose or NoExpose event from the X server.
-This is used in the #GtkText and #GtkCList widgets in GTK+ to make sure any
-GraphicsExpose events are handled before the widget is scrolled.
+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.
-Deprecated: 2.18:
+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> the #GdkWindow to wait for the events for.
+<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> a #GdkEventExpose if a GraphicsExpose was received, or %NULL if a
-NoExpose event was received.
-
-</return>
+<return></return>
</function>
-<function name="gdk_x11_visual_get_xvisual">
+<function name="gdk_window_restack">
<description>
-Returns the X visual belonging to a #GdkVisual.
+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="visual">
-<parameter_description> a #GdkVisual.
+<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> an Xlib <type>Visual*</type>.
-</return>
+<return></return>
</function>
-<function name="gdk_display_set_pointer_hooks">
+<function name="gdk_window_scroll">
<description>
-This function allows for hooking into the operation
-of getting the current location of the pointer on a particular
-display. This is only useful for such low-level tools as an
-event recorder. Applications should never have any
-reason to use this facility.
+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.
-Since: 2.2
+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="display">
-<parameter_description> a #GdkDisplay
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="new_hooks">
-<parameter_description> a table of pointers to functions for getting
-quantities related to the current pointer position,
-or %NULL to restore the default table.
+<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> the previous pointer hook table
-
-</return>
+<return></return>
</function>
-<function name="gdk_app_launch_context_set_icon">
+<function name="gdk_window_set_accept_focus">
<description>
-Sets the icon for applications that are launched with this
-context.
-
-Window Managers can use this information when displaying startup
-notification.
+Setting @accept_focus to %FALSE hints the desktop environment that the
+window doesn't want to receive input focus.
-See also gdk_app_launch_context_set_icon_name().
+On X, it is the responsibility of the window manager to interpret this
+hint. ICCCM-compliant window manager usually respect it.
-Since: 2.14
+Since: 2.4
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GdkAppLaunchContext
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="icon">
-<parameter_description> a #GIcon, or %NULL
+<parameter name="accept_focus">
+<parameter_description> %TRUE if the window should receive input focus
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_drawable_get_image">
+<function name="gdk_window_set_background">
<description>
-A #GdkImage stores client-side image data (pixels). In contrast,
-#GdkPixmap and #GdkWindow are server-side
-objects. gdk_drawable_get_image() obtains the pixels from a
-server-side drawable as a client-side #GdkImage. The format of a
-#GdkImage depends on the #GdkVisual of the current display, which
-makes manipulating #GdkImage extremely difficult; therefore, in
-most cases you should use gdk_pixbuf_get_from_drawable() instead of
-this lower-level function. A #GdkPixbuf contains image data in a
-canonicalized RGB format, rather than a display-dependent format.
-Of course, there's a convenience vs. speed tradeoff here, so you'll
-want to think about what makes sense for your application.
-
- x, @y, @width, and @height define the region of @drawable to
-obtain as an image.
-
-You would usually copy image data to the client side if you intend
-to examine the values of individual pixels, for example to darken
-an image or add a red tint. It would be prohibitively slow to
-make a round-trip request to the windowing system for each pixel,
-so instead you get all of them at once, modify them, then copy
-them all back at once.
-
-If the X server or other windowing system backend is on the local
-machine, this function may use shared memory to avoid copying
-the image data.
-
-If the source drawable is a #GdkWindow and partially offscreen
-or obscured, then the obscured portions of the returned image
-will contain undefined data.
+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().
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> x coordinate on @drawable
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> y coordinate on @drawable
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> width of region to get
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> height or region to get
+<parameter name="color">
+<parameter_description> a #GdkColor
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkImage containing the contents of @drawable
-</return>
+<return></return>
</function>
-<function name="gdk_gc_set_clip_origin">
+<function name="gdk_window_set_background_pattern">
<description>
-Sets the origin of the clip mask. The coordinates are
-interpreted relative to the upper-left corner of
-the destination drawable of the current operation.
+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="gc">
-<parameter_description> a #GdkGC.
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x-coordinate of the origin.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the y-coordinate of the origin.
+<parameter name="pattern">
+<parameter_description> a pattern to use, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_color_change">
+<function name="gdk_window_set_background_rgba">
<description>
-Changes the value of a color that has already
-been allocated. If @colormap is not a private
-colormap, then the color must have been allocated
-using gdk_colormap_alloc_colors() with the
- writeable set to %TRUE.
+Sets the background color of @window.
+See also gdk_window_set_background_pattern().
</description>
<parameters>
-<parameter name="colormap">
-<parameter_description> a #GdkColormap.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> a #GdkColor, with the color to change
-in the <structfield>pixel</structfield> field,
-and the new value in the remaining fields.
+<parameter name="rgba">
+<parameter_description> a #GdkRGBA color
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the color was successfully changed.
-</return>
+<return></return>
</function>
-<function name="gdk_window_get_children">
+<function name="gdk_window_set_child_input_shapes">
<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.
+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>
@@ -12387,926 +12504,802 @@ list need not be.
</parameter_description>
</parameter>
</parameters>
-<return> list of child windows inside @window
-</return>
+<return></return>
</function>
-<function name="gdk_display_get_n_screens">
+<function name="gdk_window_set_child_shapes">
<description>
-Gets the number of screen managed by the @display.
-
-Since: 2.2
+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="display">
-<parameter_description> a #GdkDisplay
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> number of screens.
-
-</return>
+<return></return>
</function>
-<function name="gdk_image_ref">
+<function name="gdk_window_set_composited">
<description>
-Deprecated function; use g_object_ref() instead.
-
-Deprecated: 2.0: Use g_object_ref() instead.
+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 <xref linkend="composited-window-example"/>
+for an example.
-</description>
-<parameters>
-<parameter name="image">
-<parameter_description> a #GdkImage
-</parameter_description>
-</parameter>
-</parameters>
-<return> the image
+It only makes sense for child windows to be composited; see
+gdk_window_set_opacity() if you need translucent toplevel
+windows.
-</return>
-</function>
+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.
-<function name="gdk_selection_owner_set_for_display">
-<description>
-Sets the #GdkWindow @owner as the current owner of the selection @selection.
+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.2
+Since: 2.12
</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 name="window">
+<parameter_description> a #GdkWindow
</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 name="composited">
+<parameter_description> %TRUE to set the window as composited
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the selection owner was successfully changed to owner,
-otherwise %FALSE.
-
-</return>
+<return></return>
</function>
-<function name="gdk_pixmap_foreign_new">
+<function name="gdk_window_set_cursor">
<description>
-Wraps a native window for the default display in a #GdkPixmap.
-This may fail if the pixmap has been destroyed.
-
-For example in the X backend, a native pixmap handle is an Xlib
-<type>XID</type>.
-
+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="anid">
-<parameter_description> a native pixmap handle.
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="cursor">
+<parameter_description> a cursor
</parameter_description>
</parameter>
</parameters>
-<return> the newly-created #GdkPixmap wrapper for the
-native pixmap or %NULL if the pixmap has been destroyed.
-</return>
+<return></return>
</function>
-<function name="gdk_x11_image_get_ximage">
+<function name="gdk_window_set_debug_updates">
<description>
-Returns the X image belonging to a #GdkImage.
+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="image">
-<parameter_description> a #GdkImage.
+<parameter name="setting">
+<parameter_description> %TRUE to turn on update debugging
</parameter_description>
</parameter>
</parameters>
-<return> an <type>XImage*</type>.
-</return>
+<return></return>
</function>
-<function name="gdk_screen_get_height">
+<function name="gdk_window_set_decorations">
<description>
-Gets the height of @screen in pixels
+"Decorations" 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.
-Since: 2.2
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="decorations">
+<parameter_description> decoration hint mask
</parameter_description>
</parameter>
</parameters>
-<return> the height of @screen in pixels.
-
-</return>
+<return></return>
</function>
-<function name="gdk_window_get_pointer">
+<function name="gdk_window_set_device_cursor">
<description>
-Obtains the current pointer position and modifier state.
-The position is given in coordinates relative to the upper left
-corner of @window.
+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="x">
-<parameter_description> return location for X coordinate of pointer or %NULL to not
-return the X coordinate
+<parameter_description> a #Gdkwindow
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> return location for Y coordinate of pointer or %NULL to not
-return the Y coordinate
+<parameter name="device">
+<parameter_description> a master, pointer #GdkDevice
</parameter_description>
</parameter>
-<parameter name="mask">
-<parameter_description> return location for modifier mask or %NULL to not return the
-modifier mask
+<parameter name="cursor">
+<parameter_description> a #GdkCursor
</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>
+<return></return>
</function>
-<function name="gdk_pixbuf_render_to_drawable_alpha">
+<function name="gdk_window_set_device_events">
<description>
-Renders a rectangular portion of a pixbuf to a drawable. The destination
-drawable must have a colormap. All windows have a colormap, however, pixmaps
-only have colormap by default if they were created with a non-%NULL window argument.
-Otherwise a colormap must be set on them with gdk_drawable_set_colormap.
+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.
-On older X servers, rendering pixbufs with an alpha channel involves round trips
-to the X server, and may be somewhat slow.
-
-Deprecated: 2.4: This function is obsolete. Use gdk_draw_pixbuf() instead.
+Since: 3.0
</description>
<parameters>
-<parameter name="pixbuf">
-<parameter_description> A pixbuf.
-</parameter_description>
-</parameter>
-<parameter name="drawable">
-<parameter_description> Destination drawable.
-</parameter_description>
-</parameter>
-<parameter name="src_x">
-<parameter_description> Source X coordinate within pixbuf.
-</parameter_description>
-</parameter>
-<parameter name="src_y">
-<parameter_description> Source Y coordinates within pixbuf.
-</parameter_description>
-</parameter>
-<parameter name="dest_x">
-<parameter_description> Destination X coordinate within drawable.
-</parameter_description>
-</parameter>
-<parameter name="dest_y">
-<parameter_description> Destination Y coordinate within drawable.
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> Width of region to render, in pixels, or -1 to use pixbuf width.
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> Height of region to render, in pixels, or -1 to use pixbuf height.
-</parameter_description>
-</parameter>
-<parameter name="alpha_mode">
-<parameter_description> Ignored. Present for backwards compatibility.
-</parameter_description>
-</parameter>
-<parameter name="alpha_threshold">
-<parameter_description> Ignored. Present for backwards compatibility
-</parameter_description>
-</parameter>
-<parameter name="dither">
-<parameter_description> Dithering mode for GdkRGB.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="x_dither">
-<parameter_description> X offset for dither.
+<parameter name="device">
+<parameter_description> #GdkDevice to enable events for.
</parameter_description>
</parameter>
-<parameter name="y_dither">
-<parameter_description> Y offset for dither.
+<parameter name="event_mask">
+<parameter_description> event mask for @window
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_pixbuf_render_to_drawable">
+<function name="gdk_window_set_events">
<description>
-Renders a rectangular portion of a pixbuf to a drawable while using the
-specified GC. This is done using GdkRGB, so the specified drawable must have
-the GdkRGB visual and colormap. Note that this function will ignore the
-opacity information for images with an alpha channel; the GC must already
-have the clipping mask set if you want transparent regions to show through.
-
-For an explanation of dither offsets, see the GdkRGB documentation. In
-brief, the dither offset is important when re-rendering partial regions of an
-image to a rendered version of the full image, or for when the offsets to a
-base position change, as in scrolling. The dither matrix has to be shifted
-for consistent visual results. If you do not have any of these cases, the
-dither offsets can be both zero.
-
-Deprecated: 2.4: This function is obsolete. Use gdk_draw_pixbuf() instead.
+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="pixbuf">
-<parameter_description> A pixbuf.
-</parameter_description>
-</parameter>
-<parameter name="drawable">
-<parameter_description> Destination drawable.
-</parameter_description>
-</parameter>
-<parameter name="gc">
-<parameter_description> GC used for rendering.
-</parameter_description>
-</parameter>
-<parameter name="src_x">
-<parameter_description> Source X coordinate within pixbuf.
-</parameter_description>
-</parameter>
-<parameter name="src_y">
-<parameter_description> Source Y coordinate within pixbuf.
-</parameter_description>
-</parameter>
-<parameter name="dest_x">
-<parameter_description> Destination X coordinate within drawable.
-</parameter_description>
-</parameter>
-<parameter name="dest_y">
-<parameter_description> Destination Y coordinate within drawable.
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> Width of region to render, in pixels, or -1 to use pixbuf width
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> Height of region to render, in pixels, or -1 to use pixbuf height
-</parameter_description>
-</parameter>
-<parameter name="dither">
-<parameter_description> Dithering mode for GdkRGB.
-</parameter_description>
-</parameter>
-<parameter name="x_dither">
-<parameter_description> X offset for dither.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="y_dither">
-<parameter_description> Y offset for dither.
+<parameter name="event_mask">
+<parameter_description> event mask for @window
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_colormap_change">
+<function name="gdk_window_set_focus_on_map">
<description>
-Changes the value of the first @ncolors in a private colormap
-to match the values in the <structfield>colors</structfield>
-array in the colormap. This function is obsolete and
-should not be used. See gdk_color_change().
+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="colormap">
-<parameter_description> a #GdkColormap.
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="ncolors">
-<parameter_description> the number of colors to change.
+<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_cairo_region">
+<function name="gdk_window_set_functions">
<description>
-Adds the given region to the current path of @cr.
+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.
-Since: 2.8
</description>
<parameters>
-<parameter name="cr">
-<parameter_description> a #cairo_t
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="region">
-<parameter_description> a #GdkRegion
+<parameter name="functions">
+<parameter_description> bitmask of operations to allow on @window
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_input_shape_combine_region">
+<function name="gdk_window_set_geometry_hints">
<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.
+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.
-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
-"clickable".
+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().
-On the X11 platform, this requires version 1.1 of the
-shape extension.
+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.
-On the Win32 platform, this functionality is not present and the
-function does nothing.
+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.
-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> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="offset_x">
-<parameter_description> X position of @shape_region in @window coordinates
+<parameter name="geometry">
+<parameter_description> geometry hints
</parameter_description>
</parameter>
-<parameter name="offset_y">
-<parameter_description> Y position of @shape_region in @window coordinates
+<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_draw_glyphs">
+<function name="gdk_window_set_group">
<description>
-This is a low-level function; 99% of text rendering should be done
-using gdk_draw_layout() instead.
-
-A glyph is a single image in a font. This function draws a sequence of
-glyphs. To obtain a sequence of glyphs you have to understand a
-lot about internationalized text handling, which you don't want to
-understand; thus, use gdk_draw_layout() instead of this function,
-gdk_draw_layout() handles the details.
+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="drawable">
-<parameter_description> a #GdkDrawable
-</parameter_description>
-</parameter>
-<parameter name="gc">
-<parameter_description> a #GdkGC
-</parameter_description>
-</parameter>
-<parameter name="font">
-<parameter_description> font to be used
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> X coordinate of baseline origin
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> Y coordinate of baseline origin
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="glyphs">
-<parameter_description> the glyph string to draw
+<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_text_width">
+<function name="gdk_window_set_icon_list">
<description>
-Determines the width of a given string.
+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="font">
-<parameter_description> a #GdkFont
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> the text to measure.
+<parameter name="window">
+<parameter_description> The #GdkWindow toplevel window to set the icon of.
</parameter_description>
</parameter>
-<parameter name="text_length">
-<parameter_description> the length of the text in bytes.
+<parameter name="pixbufs">
+<parameter_description>
+A list of pixbufs, of different sizes.
</parameter_description>
</parameter>
</parameters>
-<return> the width of the string in pixels.
-</return>
+<return></return>
</function>
-<function name="gdk_app_launch_context_new">
+<function name="gdk_window_set_icon_name">
<description>
-Creates a new #GdkAppLaunchContext.
-
-Since: 2.14
-
-</description>
-<parameters>
-</parameters>
-<return> a new #GdkAppLaunchContext
-
-</return>
-</function>
+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.
-<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).
+After calling this with a non-%NULL @name, calls to gdk_window_set_title()
+will not update the icon title.
-Since: 2.2
+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="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 name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="win_y">
-<parameter_description> return location for y coordinate of the pointer location relative
- & to the window origin, or %NULL
+<parameter name="name">
+<parameter_description> name of window while iconified (minimized)
</parameter_description>
</parameter>
</parameters>
-<return> the window under the mouse pointer, or %NULL
-
-</return>
+<return></return>
</function>
-<function name="gdk_cursor_get_image">
+<function name="gdk_window_set_keep_above">
<description>
-Returns a #GdkPixbuf with the image used to display the cursor.
+Set if @window must be kept above other windows. If the
+window was already above, then this function does nothing.
-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.
+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
+"keep above"; 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.8
+Since: 2.4
</description>
<parameters>
-<parameter name="cursor">
-<parameter_description> a #GdkCursor
+<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> a #GdkPixbuf representing @cursor, or %NULL
-
-</return>
+<return></return>
</function>
-<function name="gdk_window_reparent">
+<function name="gdk_window_set_keep_below">
<description>
-Reparents @window into the given @new_parent. The window being
-reparented will be unmapped as a side effect.
+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
+"keep below"; 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 #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> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> Y location inside the new parent
+<parameter name="setting">
+<parameter_description> whether to keep @window below other windows
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_gc_set_subwindow">
+<function name="gdk_window_set_modal_hint">
<description>
-Sets how drawing with this GC on a window will affect child
-windows of that window.
+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="gc">
-<parameter_description> a #GdkGC.
+<parameter name="window">
+<parameter_description> A toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="mode">
-<parameter_description> the subwindow mode.
+<parameter name="modal">
+<parameter_description> %TRUE if the window is modal, %FALSE otherwise.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_region_rect_in">
+<function name="gdk_window_set_opacity">
<description>
-Tests whether a rectangle is within a region.
+Request the windowing system to make @window partially transparent,
+with opacity 0 being fully transparent and 1 fully opaque. (Values
+of the opacity parameter are clamped to the [0,1] range.)
+
+On X11, this works only on X screens with a compositing manager
+running.
+
+For setting up per-pixel alpha, see gdk_screen_get_rgba_visual().
+For making non-toplevel windows translucent, see
+gdk_window_set_composited().
+Since: 2.12
</description>
<parameters>
-<parameter name="region">
-<parameter_description> a #GdkRegion.
+<parameter name="window">
+<parameter_description> a top-level #GdkWindow
</parameter_description>
</parameter>
-<parameter name="rectangle">
-<parameter_description> a #GdkRectangle.
+<parameter name="opacity">
+<parameter_description> opacity
</parameter_description>
</parameter>
</parameters>
-<return> %GDK_OVERLAP_RECTANGLE_IN, %GDK_OVERLAP_RECTANGLE_OUT, or
-%GDK_OVERLAP_RECTANGLE_PART, depending on whether the rectangle is inside,
-outside, or partly inside the #GdkRegion, respectively.
-</return>
+<return></return>
</function>
-<function name="gdk_string_extents">
+<function name="gdk_window_set_override_redirect">
<description>
-Gets the metrics of a nul-terminated string.
+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="font">
-<parameter_description> a #GdkFont.
-</parameter_description>
-</parameter>
-<parameter name="string">
-<parameter_description> the nul-terminated string to measure.
-</parameter_description>
-</parameter>
-<parameter name="lbearing">
-<parameter_description> the left bearing of the string.
-</parameter_description>
-</parameter>
-<parameter name="rbearing">
-<parameter_description> the right bearing of the string.
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> the width of the string.
-</parameter_description>
-</parameter>
-<parameter name="ascent">
-<parameter_description> the ascent of the string.
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="descent">
-<parameter_description> the descent of the string.
+<parameter name="override_redirect">
+<parameter_description> %TRUE if window should be override redirect
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_region_polygon">
+<function name="gdk_window_set_role">
<description>
-Creates a new #GdkRegion using the polygon defined by a
-number of points.
+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="points">
-<parameter_description> an array of #GdkPoint structs
-</parameter_description>
-</parameter>
-<parameter name="n_points">
-<parameter_description> the number of elements in the @points array
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="fill_rule">
-<parameter_description> specifies which pixels are included in the region when the
-polygon overlaps itself.
+<parameter name="role">
+<parameter_description> a string indicating its role
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkRegion based on the given polygon
-</return>
+<return></return>
</function>
-<function name="gdk_window_set_static_gravities">
+<function name="gdk_window_set_skip_pager_hint">
<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.
+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
+<emphasis>not</emphasis> 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 #GdkWindow
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="use_static">
-<parameter_description> %TRUE to turn on static gravity
+<parameter name="skips_pager">
+<parameter_description> %TRUE to skip the pager
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the server supports static gravity
-</return>
+<return></return>
</function>
-<function name="gdk_gc_set_stipple">
+<function name="gdk_window_set_skip_taskbar_hint">
<description>
-Set the stipple bitmap for a graphics context. The
-stipple will only be used if the fill mode is
-%GDK_STIPPLED or %GDK_OPAQUE_STIPPLED.
+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 <emphasis>not</emphasis> 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="gc">
-<parameter_description> a #GdkGC.
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="stipple">
-<parameter_description> the new stipple bitmap.
+<parameter name="skips_taskbar">
+<parameter_description> %TRUE to skip the taskbar
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_app_launch_context_set_timestamp">
+<function name="gdk_window_set_source_events">
<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'.
+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: 2.14
+Since: 3.0
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GdkAppLaunchContext
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="timestamp">
-<parameter_description> a timestamp
+<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_screen_set_default_colormap">
+<function name="gdk_window_set_startup_id">
<description>
-Sets the default @colormap for @screen.
+When using GTK+, typically you should use gtk_window_set_startup_id()
+instead of this low-level function.
+
+Since: 2.12
-Since: 2.2
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="colormap">
-<parameter_description> a #GdkColormap
+<parameter name="startup_id">
+<parameter_description> a string with startup-notification identifier
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_x11_get_xatom_name_for_display">
+<function name="gdk_window_set_static_gravities">
<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.
+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.
-Since: 2.2
</description>
<parameters>
-<parameter name="display">
-<parameter_description> the #GdkDisplay where @xatom is defined
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="xatom">
-<parameter_description> an X atom
+<parameter name="use_static">
+<parameter_description> %TRUE to turn on static gravity
</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> %TRUE if the server supports static gravity
</return>
</function>
-<function name="gdk_text_extents">
+<function name="gdk_window_set_support_multidevice">
<description>
-Gets the metrics of a string.
+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="font">
-<parameter_description> a #GdkFont
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> the text to measure
-</parameter_description>
-</parameter>
-<parameter name="text_length">
-<parameter_description> the length of the text in bytes. (If the
-font is a 16-bit font, this is twice the length
-of the text in characters.)
-</parameter_description>
-</parameter>
-<parameter name="lbearing">
-<parameter_description> the left bearing of the string.
-</parameter_description>
-</parameter>
-<parameter name="rbearing">
-<parameter_description> the right bearing of the string.
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> the width of the string.
-</parameter_description>
-</parameter>
-<parameter name="ascent">
-<parameter_description> the ascent of the string.
+<parameter name="window">
+<parameter_description> a #GdkWindow.
</parameter_description>
</parameter>
-<parameter name="descent">
-<parameter_description> the descent of the string.
+<parameter name="support_multidevice">
+<parameter_description> %TRUE to enable multidevice support in @window.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_get_root_coords">
+<function name="gdk_window_set_title">
<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
+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 #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> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="root_y">
-<parameter_description> return location for Y coordinate
+<parameter name="title">
+<parameter_description> title of @window
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_add_filter">
+<function name="gdk_window_set_transient_for">
<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.
+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 gdk_display_add_client_message_filter() if you are interested
-in X ClientMessage events.
+See gtk_window_set_transient_for() if you're using #GtkWindow or
+#GtkDialog.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="function">
-<parameter_description> filter callback
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to filter callback
+<parameter name="parent">
+<parameter_description> another toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_focus">
+<function name="gdk_window_set_type_hint">
<description>
-Sets keyboard focus to @window. In most cases, gtk_window_present()
-should be used on a #GtkWindow, rather than calling this function.
+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 #GdkWindow
+<parameter_description> A toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="timestamp">
-<parameter_description> timestamp of the event triggering the window focus
+<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_fullscreen">
+<function name="gdk_window_set_urgency_hint">
<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 "fullscreen"; 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.
+Toggles whether a window needs the user's
+urgent attention.
-Since: 2.2
+Since: 2.8
</description>
<parameters>
@@ -13314,1165 +13307,1063 @@ Since: 2.2
<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_parse_args">
+<function name="gdk_window_set_user_data">
<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().
+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.
-Since: 2.2
</description>
<parameters>
-<parameter name="argc">
-<parameter_description> the number of command line arguments.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="argv">
-<parameter_description> the array of command line arguments.
+<parameter name="user_data">
+<parameter_description> user data
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_screen_get_rgba_colormap">
+<function name="gdk_window_shape_combine_region">
<description>
-Gets a colormap to use for creating windows or pixmaps 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.
+Makes pixels in @window outside @shape_region be transparent,
+so that the window may be nonrectangular.
-This functionality is not implemented in the Windows backend.
+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.
-For setting an overall opacity for a top-level window, see
-gdk_window_set_opacity().
+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.
-Since: 2.8
+This function works on both toplevel and child windows.
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-</parameters>
-<return> a colormap to use for windows with
-an alpha channel or %NULL if the capability is not available.
-
-</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->x;
-y = motion_event->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 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_threads_set_lock_functions">
+<function name="gdk_window_show">
<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.
+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 method must be called before gdk_threads_init(), and cannot
-be called multiple times.
+This function maps a window so it's visible onscreen. Its opposite
+is gdk_window_hide().
-Since: 2.4
+When implementing a #GtkWidget, you should call this function on the widget's
+#GdkWindow as part of the "map" method.
</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 name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_image_get_colormap">
+<function name="gdk_window_show_unraised">
<description>
-Retrieves the colormap for a given image, if it exists. An image
-will have a colormap if the drawable from which it was created has
-a colormap, or if a colormap was set explicitely with
-gdk_image_set_colormap().
+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="image">
-<parameter_description> a #GdkImage
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> colormap for the image
-</return>
+<return></return>
</function>
-<function name="gdk_font_load_for_display">
+<function name="gdk_window_stick">
<description>
-Loads a font for use on @display.
+"Pins" 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.)
-The font may be newly loaded or looked up the font in a cache.
-You should make no assumptions about the initial reference count.
+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.
-Since: 2.2
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
-</parameter_description>
-</parameter>
-<parameter name="font_name">
-<parameter_description> a XLFD describing the font to load.
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkFont, or %NULL if the font could not be loaded.
-</return>
+<return></return>
</function>
-<function name="gdk_screen_list_visuals">
+<function name="gdk_window_thaw_toplevel_updates_libgtk_only">
<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.
+Thaws a window frozen with
+gdk_window_freeze_toplevel_updates_libgtk_only().
-Since: 2.2
+This function is not part of the GDK public API and is only
+for use by GTK+.
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> the relevant #GdkScreen.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> a list of visuals; the list must be freed, but not its
-contents
-
-</return>
+<return></return>
</function>
-<function name="gdk_region_subtract">
+<function name="gdk_window_thaw_updates">
<description>
-Subtracts the area of @source2 from the area @source1. The resulting
-area is the set of pixels contained in @source1 but not in @source2.
+Thaws a window frozen with gdk_window_freeze_updates().
</description>
<parameters>
-<parameter name="source1">
-<parameter_description> a #GdkRegion
-</parameter_description>
-</parameter>
-<parameter name="source2">
-<parameter_description> another #GdkRegion
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_x11_screen_get_window_manager_name">
+<function name="gdk_window_unfullscreen">
<description>
-Returns the name of the window manager for @screen.
+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 "fullscreen"; 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="screen">
-<parameter_description> a #GdkScreen
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the name of the window manager screen @screen, or
-"unknown" if the window manager is unknown. The string is owned by GDK
-and should not be freed.
-
-</return>
+<return></return>
</function>
-<function name="gdk_display_supports_composite">
+<function name="gdk_window_unmaximize">
<description>
-Returns %TRUE if gdk_window_set_composited() can be used
-to redirect drawing on the window using compositing.
+Unmaximizes the window. If the window wasn't maximized, then this
+function does nothing.
-Currently this only works on X11 with XComposite and
-XDamage extensions available.
+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 "maximized"; 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.
-Since: 2.12
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if windows may be composited.
-
-</return>
+<return></return>
</function>
-<function name="gdk_drag_get_selection">
+<function name="gdk_window_unstick">
<description>
-Returns the selection atom for the current source window.
+Reverse operation for gdk_window_stick(); see gdk_window_stick(),
+and gtk_window_unstick().
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GdkDragContext.
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the selection atom.
-</return>
+<return></return>
</function>
-<function name="gdk_init_check">
+<function name="gdk_window_withdraw">
<description>
-Initialize the library for use.
-
-Arguments:
-"argc" is the number of arguments.
-"argv" is an array of strings.
+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.
-Results:
-"argc" and "argv" are modified to reflect any arguments
-which were not handled. (Such arguments should either
-be handled by the application or dismissed). If initialization
-fails, returns FALSE, otherwise TRUE.
+</description>
+<parameters>
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-Side effects:
-The library is initialized.
+<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="argc">
-<parameter_description>
-</parameter_description>
-</parameter>
-<parameter name="argv">
-<parameter_description>
+<parameter name="atom">
+<parameter_description> A #GdkAtom
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the X atom corresponding to @atom.
+</return>
</function>
-<function name="gdk_keymap_lookup_key">
+<function name="gdk_x11_atom_to_xatom_for_display">
<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.
+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="keymap">
-<parameter_description> a #GdkKeymap or %NULL to use the default keymap
+<parameter name="display">
+<parameter_description> A #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> a #GdkKeymapKey with keycode, group, and level initialized
+<parameter name="atom">
+<parameter_description> A #GdkAtom, or %GDK_NONE
</parameter_description>
</parameter>
</parameters>
-<return> a keyval, or 0 if none was mapped to the given @key
+<return> the X atom corresponding to @atom, or %None
+
</return>
</function>
-<function name="gdk_drawable_get_visual">
+<function name="gdk_x11_cursor_get_xcursor">
<description>
-Gets the #GdkVisual describing the pixel format of @drawable.
+Returns the X cursor belonging to a #GdkCursor.
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<parameter name="cursor">
+<parameter_description> a #GdkCursor.
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkVisual
+<return> an Xlib <type>Cursor</type>.
</return>
</function>
-<function name="gdk_setting_get">
+<function name="gdk_x11_cursor_get_xdisplay">
<description>
-Obtains a desktop-wide setting, such as the double-click time,
-for the default screen. See gdk_screen_get_setting().
+Returns the display of a #GdkCursor.
</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 name="cursor">
+<parameter_description> a #GdkCursor.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the setting existed and a value was stored
-in @value, %FALSE otherwise.
+<return> an Xlib <type>Display*</type>.
</return>
</function>
-<function name="gdk_cursor_new_from_name">
+<function name="gdk_x11_device_get_id">
<description>
-Creates a new cursor by looking up @name in the current cursor
-theme.
+Returns the device ID as seen by XInput2.
+
+<note>
+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.
+</note>
-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 name="device">
+<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkCursor, or %NULL if there is no cursor with
-the given name
-
+<return> the XInput2 device ID.
</return>
</function>
-<function name="gdk_cairo_set_source_pixbuf">
+<function name="gdk_x11_device_manager_lookup">
<description>
-Sets the given pixbuf as the source pattern for the Cairo context.
-The pattern has an extend mode of %CAIRO_EXTEND_NONE and is aligned
-so that the origin of @pixbuf is @pixbuf_x, @pixbuf_y
+Returns the #GdkDevice that wraps the given device ID.
-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 name="device_manager">
+<parameter_description> a #GdkDeviceManager
</parameter_description>
</parameter>
-<parameter name="pixbuf_y">
-<parameter_description> Y coordinate of location to place upper left corner of @pixbuf
+<parameter name="device_id">
+<parameter_description> a device ID, as understood by the XInput2 protocol
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The #GdkDevice wrapping the device ID,
+or %NULL if the given ID doesn't currently represent a device.
+</return>
</function>
-<function name="gdk_window_scroll">
+<function name="gdk_x11_display_broadcast_startup_message">
<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.
+Sends a startup notification message of type @message_type to
+ display
-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.
+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 <ulink
+url="http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt">Startup
+Notification Protocol specification</ulink> for
+definitions of the message types and keys that can be used.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="dx">
-<parameter_description> Amount to scroll in the X direction
+<parameter name="message_type">
+<parameter_description> startup notification message type ("new", "change",
+or "remove")
</parameter_description>
</parameter>
-<parameter name="dy">
-<parameter_description> Amount to scroll in the Y direction
+<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_app_launch_context_set_display">
+<function name="gdk_x11_display_error_trap_pop">
<description>
-Sets the display on which applications will be launched when
-using this context. See also gdk_app_launch_context_set_screen().
+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
-Since: 2.14
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GdkAppLaunchContext
-</parameter_description>
-</parameter>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> the display
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> X error code or 0 on success
+</return>
</function>
-<function name="gdk_display_pointer_ungrab">
+<function name="gdk_x11_display_error_trap_pop_ignored">
<description>
-Release any pointer grab.
+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.
-Since: 2.2
+See gdk_error_trap_pop_ignored() for the all-displays-at-once
+equivalent.
+
+Since: 3.0
</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> the display
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_screen_get_window_stack">
+<function name="gdk_x11_display_error_trap_push">
<description>
-Returns a #GList of #GdkWindow<!-- -->s representing the current
-window stack.
+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.
-On X11, this is done by inspecting the _NET_CLIENT_LIST_STACKING
-property on the root window, as described in the <ulink
-url="http://www.freedesktop.org/Standards/wm-spec">Extended Window
-Manager Hints</ulink>. If the window manager does not support the
-_NET_CLIENT_LIST_STACKING hint, this function returns %NULL.
+See also gdk_error_trap_push() to push a trap on all displays.
-On other platforms, this function may return %NULL, depending on whether
-it is implementable on that platform.
+Since: 3.0
-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.
+</description>
+<parameters>
+<parameter name="display">
+<parameter_description> a #GdkDisplay
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-Since: 2.10
+<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="screen">
-<parameter_description> a #GdkScreen
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return> a list of #GdkWindow<!-- -->s for the current window stack,
-or %NULL.
+<return> the startup notification ID for @display
</return>
</function>
-<function name="gdk_screen_get_rgba_visual">
+<function name="gdk_x11_display_get_user_time">
<description>
-Gets a visual to use for creating windows or pixmaps with an
-alpha channel. See the docs for gdk_screen_get_rgba_colormap()
-for caveats.
+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="screen">
-<parameter_description> a #GdkScreen
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return> a visual to use for windows with an
-alpha channel or %NULL if the capability is not available.
+<return> the timestamp of the last user interaction
</return>
</function>
-<function name="gdk_text_extents_wc">
+<function name="gdk_x11_display_get_xdisplay">
<description>
-Gets the metrics of a string of wide characters.
+Returns the X display of a #GdkDisplay.
+
+Since: 2.2
</description>
<parameters>
-<parameter name="font">
-<parameter_description> a #GdkFont
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> the text to measure.
-</parameter_description>
-</parameter>
-<parameter name="text_length">
-<parameter_description> the length of the text in character.
-</parameter_description>
-</parameter>
-<parameter name="lbearing">
-<parameter_description> the left bearing of the string.
-</parameter_description>
-</parameter>
-<parameter name="rbearing">
-<parameter_description> the right bearing of the string.
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> the width of the string.
-</parameter_description>
-</parameter>
-<parameter name="ascent">
-<parameter_description> the ascent of the string.
-</parameter_description>
-</parameter>
-<parameter name="descent">
-<parameter_description> the descent of the string.
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> an X display.
+</return>
</function>
-<function name="gdk_pango_renderer_set_drawable">
+<function name="gdk_x11_display_grab">
<description>
-Sets the drawable the renderer draws to.
+Call XGrabServer() on @display.
+To ungrab the display again, use gdk_x11_display_ungrab().
-Since: 2.6
+gdk_x11_display_grab()/gdk_x11_display_ungrab() calls can be nested.
+
+Since: 2.2
</description>
<parameters>
-<parameter name="gdk_renderer">
-<parameter_description> a #GdkPangoRenderer
-</parameter_description>
-</parameter>
-<parameter name="drawable">
-<parameter_description> the new target drawable, or %NULL
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_region_rectangle">
+<function name="gdk_x11_display_set_cursor_theme">
<description>
-Creates a new region containing the area @rectangle.
+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="rectangle">
-<parameter_description> a #GdkRectangle
+<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> a new region
-</return>
+<return></return>
</function>
-<function name="gdk_window_set_role">
+<function name="gdk_x11_display_set_startup_notification_id">
<description>
-When using GTK+, typically you should use gtk_window_set_role() instead
-of this low-level function.
+Sets the startup notification ID for a display.
-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.
+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 "_TIME" 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="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="role">
-<parameter_description> a string indicating its role
+<parameter name="startup_id">
+<parameter_description> the startup notification ID (must be valid utf8)
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_get_show_events">
+<function name="gdk_x11_display_string_to_compound_text">
<description>
-Gets whether event debugging output is enabled.
+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> %TRUE if event debugging output is enabled.
+<return> 0 upon success, non-zero upon failure
+
</return>
</function>
-<function name="gdk_window_merge_child_shapes">
+<function name="gdk_x11_display_text_property_to_text_list">
<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_mask().
+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.)
-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.
+Since: 2.24
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<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></return>
+<return> the number of strings stored in list, or 0,
+if the conversion failed
+
+</return>
</function>
-<function name="gdk_window_at_pointer">
+<function name="gdk_x11_display_ungrab">
<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.
+Ungrab @display after it has been grabbed with
+gdk_x11_display_grab().
+Since: 2.2
</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 name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return> window under the mouse pointer
-</return>
+<return></return>
</function>
-<function name="gdk_window_get_type_hint">
+<function name="gdk_x11_display_utf8_to_compound_text">
<description>
-This function returns the type hint set for a window.
+Converts from UTF-8 to compound text.
-Since: 2.10
+Since: 2.24
</description>
<parameters>
-<parameter name="window">
-<parameter_description> A toplevel #GdkWindow
+<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> The type hint set for @window
+<return> %TRUE if the conversion succeeded,
+otherwise %FALSE
</return>
</function>
-<function name="gdk_colormap_new">
+<function name="gdk_x11_free_compound_text">
<description>
-Creates a new colormap for the given visual.
+Frees the data returned from gdk_x11_display_string_to_compound_text().
+Since: 2.24
</description>
<parameters>
-<parameter name="visual">
-<parameter_description> a #GdkVisual.
-</parameter_description>
-</parameter>
-<parameter name="allocate">
-<parameter_description> if %TRUE, the newly created colormap will be
-a private colormap, and all colors in it will be
-allocated for the applications use.
+<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> the new #GdkColormap.
-</return>
+<return></return>
</function>
-<function name="gdk_screen_get_resolution">
+<function name="gdk_x11_free_text_list">
<description>
-Gets the resolution for font handling on the screen; see
-gdk_screen_set_resolution() for full details.
+Frees the array of strings created by
+gdk_x11_display_text_property_to_text_list().
-Since: 2.10
+Since: 2.24
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<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> the current resolution, or -1 if no resolution
-has been set.
-
-</return>
+<return></return>
</function>
-<function name="gdk_draw_lines">
+<function name="gdk_x11_get_default_root_xwindow">
<description>
-Draws a series of lines connecting the given points.
-The way in which joins between lines are draw is determined by the
-#GdkCapStyle value in the #GdkGC. This can be set with
-gdk_gc_set_line_attributes().
+Gets the root window of the default screen
+(see gdk_x11_get_default_screen()).
+
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
-</parameter_description>
-</parameter>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
-</parameter_description>
-</parameter>
-<parameter name="points">
-<parameter_description> an array of #GdkPoint structures specifying the endpoints of the
-</parameter_description>
-</parameter>
-<parameter name="n_points">
-<parameter_description> the size of the @points array.
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> an Xlib <type>Window</type>.
+</return>
</function>
-<function name="gdk_pango_renderer_set_stipple">
+<function name="gdk_x11_get_default_screen">
<description>
-Sets the stipple for one render part (foreground, background, underline,
-etc.) Note that this is overwritten when iterating through the individual
-styled runs of a #PangoLayout or #PangoLayoutLine. This function is thus
-only useful when you call low level functions like pango_renderer_draw_glyphs()
-directly, or in the 'prepare_run' virtual function of a subclass of
-#GdkPangoRenderer.
+Gets the default GTK+ screen number.
-Since: 2.6
</description>
<parameters>
-<parameter name="gdk_renderer">
-<parameter_description> a #GdkPangoRenderer
-</parameter_description>
-</parameter>
-<parameter name="part">
-<parameter_description> the part to render with the stipple
-</parameter_description>
-</parameter>
-<parameter name="stipple">
-<parameter_description> the new stipple value.
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<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_display_get_xdisplay">
+<function name="gdk_x11_get_default_xdisplay">
<description>
-Returns the X display of a #GdkDisplay.
+Gets the default GTK+ display.
-Since: 2.2
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
-</parameter_description>
-</parameter>
</parameters>
-<return> an X display.
+<return> the Xlib <type>Display*</type> for
+the display specified in the <option>--display</option> command
+line option or the <envar>DISPLAY</envar> environment variable.
</return>
</function>
-<function name="gdk_color_free">
+<function name="gdk_x11_get_server_time">
<description>
-Frees a color structure created with
-gdk_color_copy().
+Routine to get the current X server time stamp.
+
</description>
<parameters>
-<parameter name="color">
-<parameter_description> a #GdkColor.
+<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></return>
+<return> the time stamp.
+</return>
</function>
-<function name="gdk_drawable_copy_to_image">
+<function name="gdk_x11_get_xatom_by_name">
<description>
-Copies a portion of @drawable into the client side image structure
- image If @image is %NULL, creates a new image of size @width x @height
-and copies into that. See gdk_drawable_get_image() for further details.
+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.
-Since: 2.4
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
-</parameter_description>
-</parameter>
-<parameter name="image">
-<parameter_description> a #GdkDrawable, or %NULL if a new @image should be created.
-</parameter_description>
-</parameter>
-<parameter name="src_x">
-<parameter_description> x coordinate on @drawable
-</parameter_description>
-</parameter>
-<parameter name="src_y">
-<parameter_description> y coordinate on @drawable
-</parameter_description>
-</parameter>
-<parameter name="dest_x">
-<parameter_description> x coordinate within @image. Must be 0 if @image is %NULL
-</parameter_description>
-</parameter>
-<parameter name="dest_y">
-<parameter_description> y coordinate within @image. Must be 0 if @image is %NULL
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> width of region to get
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> height or region to get
+<parameter name="atom_name">
+<parameter_description> a string
</parameter_description>
</parameter>
</parameters>
-<return> @image, or a new a #GdkImage containing the contents
-of @drawable
-
+<return> a X atom for GDK's default display.
</return>
</function>
-<function name="gdk_gc_set_dashes">
+<function name="gdk_x11_get_xatom_by_name_for_display">
<description>
-Sets the way dashed-lines are drawn. Lines will be
-drawn with alternating on and off segments of the
-lengths specified in @dash_list. The manner in
-which the on and off segments are drawn is determined
-by the @line_style value of the GC. (This can
-be changed with gdk_gc_set_line_attributes().)
+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.
-The @dash_offset defines the phase of the pattern,
-specifying how many pixels into the dash-list the pattern
-should actually begin.
+Since: 2.2
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
-</parameter_description>
-</parameter>
-<parameter name="dash_offset">
-<parameter_description> the phase of the dash pattern.
-</parameter_description>
-</parameter>
-<parameter name="dash_list">
-<parameter_description> an array of dash lengths.
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="n">
-<parameter_description> the number of elements in @dash_list.
+<parameter name="atom_name">
+<parameter_description> a string
</parameter_description>
</parameter>
</parameters>
-<return></return>
-</function>
-
-<function name="gdk_region_new">
-<description>
-Creates a new empty #GdkRegion.
-
+<return> a X atom for a #GdkDisplay
-</description>
-<parameters>
-</parameters>
-<return> a new empty #GdkRegion
</return>
</function>
-<function name="gdk_window_get_toplevels">
+<function name="gdk_x11_get_xatom_name">
<description>
-Obtains a list of all toplevel windows known to GDK on the default
-screen (see gdk_screen_get_toplevel_windows()).
-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.
+Returns the name of an X atom for GDK's default display. This
+function is meant mainly for debugging, so for convenience, unlike
+<function>XAtomName()</function> and gdk_atom_name(), the result
+doesn't need to be freed. Also, this function will never return %NULL,
+even if @xatom is invalid.
-Deprecated: 2.16: Use gdk_screen_get_toplevel_windows() instead.
</description>
<parameters>
+<parameter name="xatom">
+<parameter_description> an X atom for GDK's default display
+</parameter_description>
+</parameter>
</parameters>
-<return> list of toplevel windows, free with g_list_free()
-
+<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_threads_add_timeout_seconds_full">
+<function name="gdk_x11_get_xatom_name_for_display">
<description>
-A variant of gdk_threads_add_timout_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.
+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.14
+Since: 2.2
</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 name="display">
+<parameter_description> the #GdkDisplay where @xatom is defined
</parameter_description>
</parameter>
-<parameter name="notify">
-<parameter_description> function to call when the timeout is removed, or %NULL
+<parameter name="xatom">
+<parameter_description> an X atom
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
+<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_char_width_wc">
+<function name="gdk_x11_grab_server">
<description>
-Determines the width of a given wide character. (Encoded
-in the wide-character encoding of the current locale).
+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>
-<parameter name="font">
-<parameter_description> a #GdkFont
-</parameter_description>
-</parameter>
-<parameter name="character">
-<parameter_description> the character to measure.
-</parameter_description>
-</parameter>
</parameters>
-<return> the width of the character in pixels.
-</return>
+<return></return>
</function>
-<function name="gdk_drag_find_window_for_screen">
+<function name="gdk_x11_lookup_xdisplay">
<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().
+Find the #GdkDisplay corresponding to @display, if any exists.
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 name="xdisplay">
+<parameter_description> a pointer to an X Display
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GdkDisplay, if found, otherwise %NULL.
+
+</return>
</function>
-<function name="gdk_color_parse">
+<function name="gdk_x11_register_standard_event_type">
<description>
-Parses a textual specification of a color and fill in the
-<structfield>red</structfield>, <structfield>green</structfield>,
-and <structfield>blue</structfield> fields of a #GdkColor
-structure. The color is <emphasis>not</emphasis> allocated, you
-must call gdk_colormap_alloc_color() yourself. The string can
-either one of a large set of standard names. (Taken from the X11
-<filename>rgb.txt</filename> file), or it can be a hex value in the
-form 'rgb' 'rrggbb' 'rrrgggbbb' or
-'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 'fff' 'ffffff' 'fffffffff' and
-'ffffffffffff')
+Registers interest in receiving extension events with type codes
+between @event_base and <literal>event_base + n_events - 1</literal>.
+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="spec">
-<parameter_description> the string specifying the color.
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> the #GdkColor to fill in
+<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> %TRUE if the parsing succeeded.
-</return>
+<return></return>
</function>
-<function name="gdk_visual_get_best_with_both">
+<function name="gdk_x11_screen_get_monitor_output">
<description>
-Combines gdk_visual_get_best_with_depth() and gdk_visual_get_best_with_type().
+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="depth">
-<parameter_description> a bit depth
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
-<parameter name="visual_type">
-<parameter_description> a visual type
+<parameter name="monitor_num">
+<parameter_description> number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
</parameter_description>
</parameter>
</parameters>
-<return> best visual with both @depth and
- visual_type, or %NULL if none
+<return> the XID of the monitor
+
</return>
</function>
-<function name="gdk_x11_get_default_xdisplay">
+<function name="gdk_x11_screen_get_screen_number">
<description>
-Gets the default GTK+ display.
+Returns the index of a #GdkScreen.
+Since: 2.2
</description>
<parameters>
+<parameter name="screen">
+<parameter_description> a #GdkScreen.
+</parameter_description>
+</parameter>
</parameters>
-<return> the Xlib <type>Display*</type> for the display
-specified in the <option>--display</option> command line option
-or the <envar>DISPLAY</envar> environment variable.
+<return> the position of @screen among the screens of
+its display.
</return>
</function>
-<function name="gdk_screen_get_width">
+<function name="gdk_x11_screen_get_window_manager_name">
<description>
-Gets the width of @screen in pixels
+Returns the name of the window manager for @screen.
Since: 2.2
@@ -14483,226 +14374,240 @@ Since: 2.2
</parameter_description>
</parameter>
</parameters>
-<return> the width of @screen in pixels.
+<return> the name of the window manager screen @screen, or
+"unknown" if the window manager is unknown. The string is owned by GDK
+and should not be freed.
</return>
</function>
-<function name="gdk_device_free_history">
+<function name="gdk_x11_screen_get_xscreen">
<description>
-Frees an array of #GdkTimeCoord that was returned by gdk_device_get_history().
+Returns the screen of a #GdkScreen.
+
+Since: 2.2
</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 name="screen">
+<parameter_description> a #GdkScreen.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> an Xlib <type>Screen*</type>
+</return>
</function>
-<function name="gdk_gc_set_values">
+<function name="gdk_x11_screen_lookup_visual">
<description>
-Sets attributes of a graphics context in bulk. For each flag set in
- values_mask, the corresponding field will be read from @values and
-set as the new value for @gc. If you're only setting a few values
-on @gc, calling individual "setter" functions is likely more
-convenient.
+Looks up the #GdkVisual for a particular screen and X Visual ID.
+Since: 2.2
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC
-</parameter_description>
-</parameter>
-<parameter name="values">
-<parameter_description> struct containing the new values
+<parameter name="screen">
+<parameter_description> a #GdkScreen.
</parameter_description>
</parameter>
-<parameter name="values_mask">
-<parameter_description> mask indicating which struct fields are to be used
+<parameter name="xvisualid">
+<parameter_description> an X Visual ID.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GdkVisual (owned by the screen
+object), or %NULL if the visual ID wasn't found.
+
+</return>
</function>
-<function name="gdk_x11_lookup_xdisplay">
+<function name="gdk_x11_screen_supports_net_wm_hint">
<description>
-Find the #GdkDisplay corresponding to @display, if any exists.
+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
+<ulink url="http://www.freedesktop.org">http://www.freedesktop.org</ulink>.
+
+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="xdisplay">
-<parameter_description> a pointer to an X Display
+<parameter name="screen">
+<parameter_description> the relevant #GdkScreen.
+</parameter_description>
+</parameter>
+<parameter name="property">
+<parameter_description> a property atom.
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkDisplay, if found, otherwise %NULL.
+<return> %TRUE if the window manager supports @property
</return>
</function>
-<function name="gdk_init">
+<function name="gdk_x11_set_sm_client_id">
<description>
+Sets the <literal>SM_CLIENT_ID</literal> 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="argc">
-<parameter_description>
-</parameter_description>
-</parameter>
-<parameter name="argv">
-<parameter_description>
+<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_region_get_clipbox">
+<function name="gdk_x11_ungrab_server">
<description>
-Obtains the smallest rectangle which includes the entire #GdkRegion.
-
+Ungrab the default display after it has been grabbed with
+gdk_x11_grab_server().
</description>
<parameters>
-<parameter name="region">
-<parameter_description> a #GdkRegion
-</parameter_description>
-</parameter>
-<parameter name="rectangle">
-<parameter_description> return location for the clipbox
-</parameter_description>
-</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_get_group">
+<function name="gdk_x11_visual_get_xvisual">
<description>
-Returns the group leader window for @window. See gdk_window_set_group().
+Returns the X visual belonging to a #GdkVisual.
-Since: 2.4
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="visual">
+<parameter_description> a #GdkVisual.
</parameter_description>
</parameter>
</parameters>
-<return> the group leader window for @window
-
+<return> an Xlib <type>Visual*</type>.
</return>
</function>
-<function name="gdk_pango_renderer_get_default">
+<function name="gdk_x11_window_foreign_new_for_display">
<description>
-Gets the default #PangoRenderer for a screen. This default renderer
-is shared by all users of the display, so properties such as the color
-or transformation matrix set for the renderer may be overwritten
-by functions such as gdk_draw_layout().
+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.
-Before using the renderer, you need to call gdk_pango_renderer_set_drawable()
-and gdk_pango_renderer_set_gc() to set the drawable and graphics context
-to use for drawing.
+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.6
+Since: 2.24
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="display">
+<parameter_description> the #GdkDisplay where the window handle comes from.
+</parameter_description>
+</parameter>
+<parameter name="window">
+<parameter_description> an XLib <type>Window</type>
</parameter_description>
</parameter>
</parameters>
-<return> the default #PangoRenderer for @screen. The
-renderer is owned by GTK+ and will be kept around until the
-screen is closed.
+<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_region_copy">
+<function name="gdk_x11_window_get_xid">
<description>
-Copies @region, creating an identical new region.
+Returns the X resource (window) belonging to a #GdkWindow.
</description>
<parameters>
-<parameter name="region">
-<parameter_description> a #GdkRegion
+<parameter name="window">
+<parameter_description> a native #GdkWindow.
</parameter_description>
</parameter>
</parameters>
-<return> a new region identical to @region
+<return> the ID of @drawable's X resource.
</return>
</function>
-<function name="gdk_window_show">
+<function name="gdk_x11_window_lookup_for_display">
<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().
+Looks up the #GdkWindow that wraps the given native window handle.
-When implementing a #GtkWidget, you should call this function on the widget's
-#GdkWindow as part of the "map" method.
+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> a #GdkWindow
+<parameter_description> an XLib <type>Window</type>
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GdkWindow wrapper for the native
+window, or %NULL if there is none.
+
+</return>
</function>
-<function name="gdk_threads_add_timeout">
+<function name="gdk_x11_window_move_to_current_desktop">
<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().
+Moves the window to the correct workspace when running under a
+window manager that supports multiple workspaces, as described
+in the <ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended
+Window Manager Hints</ulink>. Will not do anything if the
+window is already on all workspaces.
-Since: 2.12
+Since: 2.8
</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 name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
-
-</return>
+<return></return>
</function>
-<function name="gdk_window_thaw_updates">
+<function name="gdk_x11_window_set_theme_variant">
<description>
-Thaws a window frozen with gdk_window_freeze_updates().
+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>
@@ -14710,80 +14615,83 @@ Thaws a window frozen with gdk_window_freeze_updates().
<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_get_default_root_xwindow">
+<function name="gdk_x11_window_set_user_time">
<description>
-Gets the root window of the default screen
-(see gdk_x11_get_default_screen()).
+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 "pop-up" 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> an Xlib <type>Window</type>.
-</return>
+<return></return>
</function>
-<function name="gdk_text_width_wc">
+<function name="gdk_x11_xatom_to_atom">
<description>
-Determines the width of a given wide-character string.
+Convert from an X atom for the default display to the corresponding
+#GdkAtom.
</description>
<parameters>
-<parameter name="font">
-<parameter_description> a #GdkFont
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> the text to measure.
-</parameter_description>
-</parameter>
-<parameter name="text_length">
-<parameter_description> the length of the text in characters.
+<parameter name="xatom">
+<parameter_description> an X atom for the default GDK display
</parameter_description>
</parameter>
</parameters>
-<return> the width of the string in pixels.
+<return> the corresponding G#dkAtom.
</return>
</function>
-<function name="gdk_x11_display_broadcast_startup_message">
+<function name="gdk_x11_xatom_to_atom_for_display">
<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 <ulink
-url="http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt">Startup
-Notification Protocol specification</ulink> for
-definitions of the message types and keys that can be used.
+Convert from an X atom for a #GdkDisplay to the corresponding
+#GdkAtom.
-Since: 2.12
+Since: 2.2
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
-</parameter_description>
-</parameter>
-<parameter name="message_type">
-<parameter_description> startup notification message type ("new", "change",
-or "remove")
+<parameter_description> A #GdkDisplay
</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 name="xatom">
+<parameter_description> an X atom
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the corresponding #GdkAtom.
+
+</return>
</function>
</root>
diff --git a/gdk/src/gdk_extra_objects.defs b/gdk/src/gdk_extra_objects.defs
index 6c701a4..aa9ab66 100644
--- a/gdk/src/gdk_extra_objects.defs
+++ b/gdk/src/gdk_extra_objects.defs
@@ -12,6 +12,12 @@
(gtype-id "GDK_TYPE_CURSOR")
)
+(define-object Device
+ (in-module "Gdk")
+ (c-name "GdkDevice")
+ (gtype-id "GDK_TYPE_DEVICE")
+)
+
(define-object Display
(in-module "Gdk")
(c-name "GdkDisplay")
@@ -24,6 +30,18 @@
(gtype-id "GDK_TYPE_EVENT")
)
+(define-object Pixbuf
+ (in-module "Gdk")
+ (c-name "GdkPixbuf")
+ (gtype-id "GDK_TYPE_PIXBUF")
+)
+
+(define-object PixbufFormat
+ (in-module "Gdk")
+ (c-name "GdkPixbufFormat")
+ (gtype-id "GDK_TYPE_PIXBUF_FORMAT")
+)
+
(define-object Region
(in-module "Gdk")
(c-name "GdkRegion")
diff --git a/gdk/src/gdk_methods.defs b/gdk/src/gdk_methods.defs
index ac5d9ee..0886c69 100644
--- a/gdk/src/gdk_methods.defs
+++ b/gdk/src/gdk_methods.defs
@@ -287,9 +287,23 @@
'("button3-mask" "GDK_BUTTON3_MASK")
'("button4-mask" "GDK_BUTTON4_MASK")
'("button5-mask" "GDK_BUTTON5_MASK")
+ '("modifier-reserved-13-mask" "GDK_MODIFIER_RESERVED_13_MASK")
+ '("modifier-reserved-14-mask" "GDK_MODIFIER_RESERVED_14_MASK")
+ '("modifier-reserved-15-mask" "GDK_MODIFIER_RESERVED_15_MASK")
+ '("modifier-reserved-16-mask" "GDK_MODIFIER_RESERVED_16_MASK")
+ '("modifier-reserved-17-mask" "GDK_MODIFIER_RESERVED_17_MASK")
+ '("modifier-reserved-18-mask" "GDK_MODIFIER_RESERVED_18_MASK")
+ '("modifier-reserved-19-mask" "GDK_MODIFIER_RESERVED_19_MASK")
+ '("modifier-reserved-20-mask" "GDK_MODIFIER_RESERVED_20_MASK")
+ '("modifier-reserved-21-mask" "GDK_MODIFIER_RESERVED_21_MASK")
+ '("modifier-reserved-22-mask" "GDK_MODIFIER_RESERVED_22_MASK")
+ '("modifier-reserved-23-mask" "GDK_MODIFIER_RESERVED_23_MASK")
+ '("modifier-reserved-24-mask" "GDK_MODIFIER_RESERVED_24_MASK")
+ '("modifier-reserved-25-mask" "GDK_MODIFIER_RESERVED_25_MASK")
'("super-mask" "GDK_SUPER_MASK")
'("hyper-mask" "GDK_HYPER_MASK")
'("meta-mask" "GDK_META_MASK")
+ '("modifier-reserved-29-mask" "GDK_MODIFIER_RESERVED_29_MASK")
'("release-mask" "GDK_RELEASE_MASK")
'("modifier-mask" "GDK_MODIFIER_MASK")
)
@@ -631,8 +645,8 @@
(parameters
'("cairo_t*" "cr")
'("const-GdkPixbuf*" "pixbuf")
- '("double" "pixbuf_x")
- '("double" "pixbuf_y")
+ '("gdouble" "pixbuf_x")
+ '("gdouble" "pixbuf_y")
)
)
@@ -642,8 +656,8 @@
(parameters
'("cairo_t*" "cr")
'("GdkWindow*" "window")
- '("double" "x")
- '("double" "y")
+ '("gdouble" "x")
+ '("gdouble" "y")
)
)
@@ -677,6 +691,11 @@
;; From gdkcolor.h
+(define-function gdk_color_get_type
+ (c-name "gdk_color_get_type")
+ (return-type "GType")
+)
+
(define-method copy
(of-object "GdkColor")
(c-name "gdk_color_copy")
@@ -689,15 +708,6 @@
(return-type "none")
)
-(define-function gdk_color_parse
- (c-name "gdk_color_parse")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "spec")
- '("GdkColor*" "color")
- )
-)
-
(define-method hash
(of-object "GdkColor")
(c-name "gdk_color_hash")
@@ -713,17 +723,21 @@
)
)
+(define-function gdk_color_parse
+ (c-name "gdk_color_parse")
+ (return-type "gboolean")
+ (parameters
+ '("const-gchar*" "spec")
+ '("GdkColor*" "color")
+ )
+)
+
(define-method to_string
(of-object "GdkColor")
(c-name "gdk_color_to_string")
(return-type "gchar*")
)
-(define-function gdk_color_get_type
- (c-name "gdk_color_get_type")
- (return-type "GType")
-)
-
;; From gdkconfig.h
@@ -1875,6 +1889,51 @@
)
)
+(define-method get_button
+ (of-object "GdkEvent")
+ (c-name "gdk_event_get_button")
+ (return-type "gboolean")
+ (parameters
+ '("guint*" "button")
+ )
+)
+
+(define-method get_click_count
+ (of-object "GdkEvent")
+ (c-name "gdk_event_get_click_count")
+ (return-type "gboolean")
+ (parameters
+ '("guint*" "click_count")
+ )
+)
+
+(define-method get_keyval
+ (of-object "GdkEvent")
+ (c-name "gdk_event_get_keyval")
+ (return-type "gboolean")
+ (parameters
+ '("guint*" "keyval")
+ )
+)
+
+(define-method get_keycode
+ (of-object "GdkEvent")
+ (c-name "gdk_event_get_keycode")
+ (return-type "gboolean")
+ (parameters
+ '("guint16*" "keycode")
+ )
+)
+
+(define-method get_scroll_direction
+ (of-object "GdkEvent")
+ (c-name "gdk_event_get_scroll_direction")
+ (return-type "gboolean")
+ (parameters
+ '("GdkScrollDirection*" "direction")
+ )
+)
+
(define-method get_axis
(of-object "GdkEvent")
(c-name "gdk_event_get_axis")
@@ -2425,10 +2484,10 @@
(return-type "GdkPixbuf*")
(parameters
'("GdkWindow*" "window")
- '("int" "src_x")
- '("int" "src_y")
- '("int" "width")
- '("int" "height")
+ '("gint" "src_x")
+ '("gint" "src_y")
+ '("gint" "width")
+ '("gint" "height")
)
)
@@ -2437,10 +2496,10 @@
(return-type "GdkPixbuf*")
(parameters
'("cairo_surface_t*" "surface")
- '("int" "src_x")
- '("int" "src_y")
- '("int" "width")
- '("int" "height")
+ '("gint" "src_x")
+ '("gint" "src_y")
+ '("gint" "width")
+ '("gint" "height")
)
)
@@ -2585,6 +2644,11 @@
;; From gdkrgba.h
+(define-function gdk_rgba_get_type
+ (c-name "gdk_rgba_get_type")
+ (return-type "GType")
+)
+
(define-method copy
(of-object "GdkRGBA")
(c-name "gdk_rgba_copy")
@@ -2597,15 +2661,6 @@
(return-type "none")
)
-(define-method parse
- (of-object "GdkRGBA")
- (c-name "gdk_rgba_parse")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "spec")
- )
-)
-
(define-function gdk_rgba_hash
(c-name "gdk_rgba_hash")
(return-type "guint")
@@ -2623,17 +2678,21 @@
)
)
+(define-method parse
+ (of-object "GdkRGBA")
+ (c-name "gdk_rgba_parse")
+ (return-type "gboolean")
+ (parameters
+ '("const-gchar*" "spec")
+ )
+)
+
(define-method to_string
(of-object "GdkRGBA")
(c-name "gdk_rgba_to_string")
(return-type "gchar*")
)
-(define-function gdk_rgba_get_type
- (c-name "gdk_rgba_get_type")
- (return-type "GType")
-)
-
;; From gdkscreen.h
diff --git a/gdk/src/gdk_pixbuf_enums.defs b/gdk/src/gdk_pixbuf_enums.defs
index 2d1edfc..504676e 100644
--- a/gdk/src/gdk_pixbuf_enums.defs
+++ b/gdk/src/gdk_pixbuf_enums.defs
@@ -1,4 +1,11 @@
-;; From /home/murrayc/svn/gnome218/gtk+/gdk-pixbuf/gdk-pixbuf-core.h
+;; From gdk-pixbuf-core.h
+
+;; Original typedef:
+;; typedef enum
+;; {
+;; GDK_PIXBUF_ALPHA_BILEVEL,
+;; GDK_PIXBUF_ALPHA_FULL
+;; } GdkPixbufAlphaMode;
(define-enum-extended PixbufAlphaMode
(in-module "Gdk")
@@ -9,14 +16,34 @@
)
)
+;; Original typedef:
+;; typedef enum {
+;; GDK_COLORSPACE_RGB
+;; } GdkColorspace;
+
(define-enum-extended Colorspace
(in-module "Gdk")
(c-name "GdkColorspace")
(values
- '("b" "GDK_COLORSPACE_RGB" "0")
+ '("rgb" "GDK_COLORSPACE_RGB" "0")
)
)
+;; Original typedef:
+;; typedef enum {
+;; /* image data hosed */
+;; GDK_PIXBUF_ERROR_CORRUPT_IMAGE,
+;; /* no mem to load image */
+;; GDK_PIXBUF_ERROR_INSUFFICIENT_MEMORY,
+;; /* bad option passed to save routine */
+;; GDK_PIXBUF_ERROR_BAD_OPTION,
+;; /* unsupported image type (sort of an ENOSYS) */
+;; GDK_PIXBUF_ERROR_UNKNOWN_TYPE,
+;; /* unsupported operation (load, save) for image type */
+;; GDK_PIXBUF_ERROR_UNSUPPORTED_OPERATION,
+;; GDK_PIXBUF_ERROR_FAILED
+;; } GdkPixbufError;
+
(define-enum-extended PixbufError
(in-module "Gdk")
(c-name "GdkPixbufError")
@@ -30,7 +57,15 @@
)
)
-;; From /home/murrayc/svn/gnome218/gtk+/gdk-pixbuf/gdk-pixbuf-io.h
+;; From gdk-pixbuf-io.h
+
+;; Original typedef:
+;; typedef enum /*< skip >*/
+;; {
+;; GDK_PIXBUF_FORMAT_WRITABLE = 1 << 0,
+;; GDK_PIXBUF_FORMAT_SCALABLE = 1 << 1,
+;; GDK_PIXBUF_FORMAT_THREADSAFE = 1 << 2
+;; } GdkPixbufFormatFlags;
(define-flags-extended PixbufFormatFlags
(in-module "Gdk")
@@ -42,7 +77,15 @@
)
)
-;; From /home/murrayc/svn/gnome218/gtk+/gdk-pixbuf/gdk-pixbuf-transform.h
+;; From gdk-pixbuf-transform.h
+
+;; Original typedef:
+;; typedef enum {
+;; GDK_INTERP_NEAREST,
+;; GDK_INTERP_TILES,
+;; GDK_INTERP_BILINEAR,
+;; GDK_INTERP_HYPER
+;; } GdkInterpType;
(define-enum-extended InterpType
(in-module "Gdk")
@@ -55,6 +98,14 @@
)
)
+;; Original typedef:
+;; typedef enum {
+;; GDK_PIXBUF_ROTATE_NONE = 0,
+;; GDK_PIXBUF_ROTATE_COUNTERCLOCKWISE = 90,
+;; GDK_PIXBUF_ROTATE_UPSIDEDOWN = 180,
+;; GDK_PIXBUF_ROTATE_CLOCKWISE = 270
+;; } GdkPixbufRotation;
+
(define-enum-extended PixbufRotation
(in-module "Gdk")
(c-name "GdkPixbufRotation")
@@ -66,26 +117,63 @@
)
)
-;; From /home/murrayc/svn/gnome218/gtk+/gdk-pixbuf/gdk-pixdata.h
+;; From gdk-pixdata.h
+
+;; Original typedef:
+;; typedef enum
+;; {
+;; /* colorspace + alpha */
+;; GDK_PIXDATA_COLOR_TYPE_RGB = 0x01,
+;; GDK_PIXDATA_COLOR_TYPE_RGBA = 0x02,
+;; GDK_PIXDATA_COLOR_TYPE_MASK = 0xff,
+;; /* width, support 8bits only currently */
+;; GDK_PIXDATA_SAMPLE_WIDTH_8 = 0x01 << 16,
+;; GDK_PIXDATA_SAMPLE_WIDTH_MASK = 0x0f << 16,
+;; /* encoding */
+;; GDK_PIXDATA_ENCODING_RAW = 0x01 << 24,
+;; GDK_PIXDATA_ENCODING_RLE = 0x02 << 24,
+;; GDK_PIXDATA_ENCODING_MASK = 0x0f << 24
+;; } GdkPixdataType;
(define-flags-extended PixdataType
(in-module "Gdk")
(c-name "GdkPixdataType")
(values
- '("rgb" "GDK_PIXDATA_COLOR_TYPE_RGB" "0x01")
- '("rgba" "GDK_PIXDATA_COLOR_TYPE_RGBA" "0x02")
- '("mask" "GDK_PIXDATA_COLOR_TYPE_MASK" "0xff")
+ '("color-type-rgb" "GDK_PIXDATA_COLOR_TYPE_RGB" "0x01")
+ '("color-type-rgba" "GDK_PIXDATA_COLOR_TYPE_RGBA" "0x02")
+ '("color-type-mask" "GDK_PIXDATA_COLOR_TYPE_MASK" "0xff")
+ '("sample-width-8" "GDK_PIXDATA_SAMPLE_WIDTH_8" "0x01 << 16")
+ '("sample-width-mask" "GDK_PIXDATA_SAMPLE_WIDTH_MASK" "0x0f << 16")
+ '("encoding-raw" "GDK_PIXDATA_ENCODING_RAW" "0x01 << 24")
+ '("encoding-rle" "GDK_PIXDATA_ENCODING_RLE" "0x02 << 24")
+ '("encoding-mask" "GDK_PIXDATA_ENCODING_MASK" "0x0f << 24")
)
)
+;; Original typedef:
+;; typedef enum
+;; {
+;; /* type of source to save */
+;; GDK_PIXDATA_DUMP_PIXDATA_STREAM = 0,
+;; GDK_PIXDATA_DUMP_PIXDATA_STRUCT = 1,
+;; GDK_PIXDATA_DUMP_MACROS = 2,
+;; /* type of variables to use */
+;; GDK_PIXDATA_DUMP_GTYPES = 0,
+;; GDK_PIXDATA_DUMP_CTYPES = 1 << 8,
+;; GDK_PIXDATA_DUMP_STATIC = 1 << 9,
+;; GDK_PIXDATA_DUMP_CONST = 1 << 10,
+;; /* save RLE decoder macro? */
+;; GDK_PIXDATA_DUMP_RLE_DECODER = 1 << 16
+;; } GdkPixdataDumpType;
+
(define-flags-extended PixdataDumpType
(in-module "Gdk")
(c-name "GdkPixdataDumpType")
(values
- '("pixdata-stream" "GDK_PIXDATA_DUMP_PIXDATA_STREAM" "0")
- '("pixdata-struct" "GDK_PIXDATA_DUMP_PIXDATA_STRUCT" "1")
- '("macros" "GDK_PIXDATA_DUMP_MACROS" "2")
- '("gtypes" "GDK_PIXDATA_DUMP_GTYPES" "0")
+ '("pixdata-stream" "GDK_PIXDATA_DUMP_PIXDATA_STREAM" "0x0")
+ '("pixdata-struct" "GDK_PIXDATA_DUMP_PIXDATA_STRUCT" "0x1")
+ '("macros" "GDK_PIXDATA_DUMP_MACROS" "0x2")
+ '("gtypes" "GDK_PIXDATA_DUMP_GTYPES" "0x0")
'("ctypes" "GDK_PIXDATA_DUMP_CTYPES" "1 << 8")
'("static" "GDK_PIXDATA_DUMP_STATIC" "1 << 9")
'("const" "GDK_PIXDATA_DUMP_CONST" "1 << 10")
diff --git a/gtk/src/gtk_methods.defs b/gtk/src/gtk_methods.defs
index eb189e3..b57bccc 100644
--- a/gtk/src/gtk_methods.defs
+++ b/gtk/src/gtk_methods.defs
@@ -1397,6 +1397,22 @@
)
)
+(define-enum CssSectionType
+ (in-module "Gtk")
+ (c-name "GtkCssSectionType")
+ (gtype-id "GTK_TYPE_CSS_SECTION_TYPE")
+ (values
+ '("document" "GTK_CSS_SECTION_DOCUMENT")
+ '("import" "GTK_CSS_SECTION_IMPORT")
+ '("color-definition" "GTK_CSS_SECTION_COLOR_DEFINITION")
+ '("binding-set" "GTK_CSS_SECTION_BINDING_SET")
+ '("ruleset" "GTK_CSS_SECTION_RULESET")
+ '("selector" "GTK_CSS_SECTION_SELECTOR")
+ '("declaration" "GTK_CSS_SECTION_DECLARATION")
+ '("value" "GTK_CSS_SECTION_VALUE")
+ )
+)
+
(define-flags DebugFlag
(in-module "Gtk")
(c-name "GtkDebugFlag")
@@ -8543,6 +8559,69 @@
+;; From gtkcsssection.h
+
+(define-function gtk_css_section_get_type
+ (c-name "gtk_css_section_get_type")
+ (return-type "GType")
+)
+
+(define-method ref
+ (of-object "GtkCssSection")
+ (c-name "gtk_css_section_ref")
+ (return-type "GtkCssSection*")
+)
+
+(define-method unref
+ (of-object "GtkCssSection")
+ (c-name "gtk_css_section_unref")
+ (return-type "none")
+)
+
+(define-method get_section_type
+ (of-object "GtkCssSection")
+ (c-name "gtk_css_section_get_section_type")
+ (return-type "GtkCssSectionType")
+)
+
+(define-method get_parent
+ (of-object "GtkCssSection")
+ (c-name "gtk_css_section_get_parent")
+ (return-type "GtkCssSection*")
+)
+
+(define-method get_file
+ (of-object "GtkCssSection")
+ (c-name "gtk_css_section_get_file")
+ (return-type "GFile*")
+)
+
+(define-method get_start_line
+ (of-object "GtkCssSection")
+ (c-name "gtk_css_section_get_start_line")
+ (return-type "guint")
+)
+
+(define-method get_start_position
+ (of-object "GtkCssSection")
+ (c-name "gtk_css_section_get_start_position")
+ (return-type "guint")
+)
+
+(define-method get_end_line
+ (of-object "GtkCssSection")
+ (c-name "gtk_css_section_get_end_line")
+ (return-type "guint")
+)
+
+(define-method get_end_position
+ (of-object "GtkCssSection")
+ (c-name "gtk_css_section_get_end_position")
+ (return-type "guint")
+)
+
+
+
;; From gtkdebug.h
(define-function gtk_get_debug_flags
@@ -11517,6 +11596,16 @@
)
)
+(define-method get_child_at
+ (of-object "GtkGrid")
+ (c-name "gtk_grid_get_child_at")
+ (return-type "GtkWidget*")
+ (parameters
+ '("gint" "left")
+ '("gint" "top")
+ )
+)
+
(define-method insert_row
(of-object "GtkGrid")
(c-name "gtk_grid_insert_row")
@@ -29385,6 +29474,11 @@
(return-type "GType")
)
+(define-function gtk_css_section_type_get_type
+ (c-name "gtk_css_section_type_get_type")
+ (return-type "GType")
+)
+
(define-function gtk_debug_flag_get_type
(c-name "gtk_debug_flag_get_type")
(return-type "GType")
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
